openapi: 3.0.1
info:
title: HAPI FHIR Server
contact: {}
version: 8.4.0
servers:
- url: https://conectaton.msal.gob.ar/nodo/fhir
description: HAPI FHIR Server
tags:
- name: System Level Operations
description: Server-level operations
- name: Account
description: "The Account FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Account"
- name: ActivityDefinition
description: "The ActivityDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
- name: AdverseEvent
description: "The AdverseEvent FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/AdverseEvent"
- name: AllergyIntolerance
description: "The AllergyIntolerance FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
- name: Appointment
description: "The Appointment FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Appointment"
- name: AppointmentResponse
description: "The AppointmentResponse FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/AppointmentResponse"
- name: AuditEvent
description: "The AuditEvent FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/AuditEvent"
- name: Basic
description: "The Basic FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Basic"
- name: Binary
description: "The Binary FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Binary"
- name: BiologicallyDerivedProduct
description: "The BiologicallyDerivedProduct FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct"
- name: BodyStructure
description: "The BodyStructure FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/BodyStructure"
- name: Bundle
description: "The Bundle FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Bundle"
- name: CapabilityStatement
description: "The CapabilityStatement FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/CapabilityStatement"
- name: CarePlan
description: "The CarePlan FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/CarePlan"
- name: CareTeam
description: "The CareTeam FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/CareTeam"
- name: CatalogEntry
description: "The CatalogEntry FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/CatalogEntry"
- name: ChargeItem
description: "The ChargeItem FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ChargeItem"
- name: ChargeItemDefinition
description: "The ChargeItemDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition"
- name: Claim
description: "The Claim FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Claim"
- name: ClaimResponse
description: "The ClaimResponse FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ClaimResponse"
- name: ClinicalImpression
description: "The ClinicalImpression FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ClinicalImpression"
- name: CodeSystem
description: "The CodeSystem FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/CodeSystem"
- name: Communication
description: "The Communication FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Communication"
- name: CommunicationRequest
description: "The CommunicationRequest FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/CommunicationRequest"
- name: CompartmentDefinition
description: "The CompartmentDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/CompartmentDefinition"
- name: Composition
description: "The Composition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Composition"
- name: ConceptMap
description: "The ConceptMap FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ConceptMap"
- name: Condition
description: "The Condition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Condition"
- name: Consent
description: "The Consent FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Consent"
- name: Contract
description: "The Contract FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Contract"
- name: Coverage
description: "The Coverage FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Coverage"
- name: CoverageEligibilityRequest
description: "The CoverageEligibilityRequest FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest"
- name: CoverageEligibilityResponse
description: "The CoverageEligibilityResponse FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/CoverageEligibilityResponse"
- name: DetectedIssue
description: "The DetectedIssue FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/DetectedIssue"
- name: Device
description: "The Device FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Device"
- name: DeviceDefinition
description: "The DeviceDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/DeviceDefinition"
- name: DeviceMetric
description: "The DeviceMetric FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/DeviceMetric"
- name: DeviceRequest
description: "The DeviceRequest FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/DeviceRequest"
- name: DeviceUseStatement
description: "The DeviceUseStatement FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/DeviceUseStatement"
- name: DiagnosticReport
description: "The DiagnosticReport FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
- name: DocumentManifest
description: "The DocumentManifest FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/DocumentManifest"
- name: DocumentReference
description: "The DocumentReference FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/DocumentReference"
- name: EffectEvidenceSynthesis
description: "The EffectEvidenceSynthesis FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/EffectEvidenceSynthesis"
- name: Encounter
description: "The Encounter FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Encounter"
- name: Endpoint
description: "The Endpoint FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Endpoint"
- name: EnrollmentRequest
description: "The EnrollmentRequest FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/EnrollmentRequest"
- name: EnrollmentResponse
description: "The EnrollmentResponse FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/EnrollmentResponse"
- name: EpisodeOfCare
description: "The EpisodeOfCare FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
- name: EventDefinition
description: "The EventDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/EventDefinition"
- name: Evidence
description: "The Evidence FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Evidence"
- name: EvidenceVariable
description: "The EvidenceVariable FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/EvidenceVariable"
- name: ExampleScenario
description: "The ExampleScenario FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ExampleScenario"
- name: ExplanationOfBenefit
description: "The ExplanationOfBenefit FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit"
- name: FamilyMemberHistory
description: "The FamilyMemberHistory FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory"
- name: Flag
description: "The Flag FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Flag"
- name: Goal
description: "The Goal FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Goal"
- name: GraphDefinition
description: "The GraphDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/GraphDefinition"
- name: Group
description: "The Group FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Group"
- name: GuidanceResponse
description: "The GuidanceResponse FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/GuidanceResponse"
- name: HealthcareService
description: "The HealthcareService FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/HealthcareService"
- name: ImagingStudy
description: "The ImagingStudy FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ImagingStudy"
- name: Immunization
description: "The Immunization FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Immunization"
- name: ImmunizationEvaluation
description: "The ImmunizationEvaluation FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation"
- name: ImmunizationRecommendation
description: "The ImmunizationRecommendation FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"
- name: ImplementationGuide
description: "The ImplementationGuide FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ImplementationGuide"
- name: InsurancePlan
description: "The InsurancePlan FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/InsurancePlan"
- name: Invoice
description: "The Invoice FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Invoice"
- name: Library
description: "The Library FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Library"
- name: Linkage
description: "The Linkage FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Linkage"
- name: List
description: "The List FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/List"
- name: Location
description: "The Location FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Location"
- name: Measure
description: "The Measure FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Measure"
- name: MeasureReport
description: "The MeasureReport FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/MeasureReport"
- name: Media
description: "The Media FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Media"
- name: Medication
description: "The Medication FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Medication"
- name: MedicationAdministration
description: "The MedicationAdministration FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/MedicationAdministration"
- name: MedicationDispense
description: "The MedicationDispense FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/MedicationDispense"
- name: MedicationKnowledge
description: "The MedicationKnowledge FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/MedicationKnowledge"
- name: MedicationRequest
description: "The MedicationRequest FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/MedicationRequest"
- name: MedicationStatement
description: "The MedicationStatement FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/MedicationStatement"
- name: MedicinalProduct
description: "The MedicinalProduct FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/MedicinalProduct"
- name: MedicinalProductAuthorization
description: "The MedicinalProductAuthorization FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/MedicinalProductAuthorization"
- name: MedicinalProductContraindication
description: "The MedicinalProductContraindication FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/MedicinalProductContraindication"
- name: MedicinalProductIndication
description: "The MedicinalProductIndication FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/MedicinalProductIndication"
- name: MedicinalProductIngredient
description: "The MedicinalProductIngredient FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/MedicinalProductIngredient"
- name: MedicinalProductInteraction
description: "The MedicinalProductInteraction FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/MedicinalProductInteraction"
- name: MedicinalProductManufactured
description: "The MedicinalProductManufactured FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/MedicinalProductManufactured"
- name: MedicinalProductPackaged
description: "The MedicinalProductPackaged FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/MedicinalProductPackaged"
- name: MedicinalProductPharmaceutical
description: "The MedicinalProductPharmaceutical FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/MedicinalProductPharmaceutical"
- name: MedicinalProductUndesirableEffect
description: "The MedicinalProductUndesirableEffect FHIR resource type
Base\
\ profile: http://hl7.org/fhir/StructureDefinition/MedicinalProductUndesirableEffect"
- name: MessageDefinition
description: "The MessageDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/MessageDefinition"
- name: MessageHeader
description: "The MessageHeader FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/MessageHeader"
- name: MolecularSequence
description: "The MolecularSequence FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/MolecularSequence"
- name: NamingSystem
description: "The NamingSystem FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/NamingSystem"
- name: NutritionOrder
description: "The NutritionOrder FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/NutritionOrder"
- name: Observation
description: "The Observation FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Observation"
- name: ObservationDefinition
description: "The ObservationDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ObservationDefinition"
- name: OperationDefinition
description: "The OperationDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/OperationDefinition"
- name: OperationOutcome
description: "The OperationOutcome FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/OperationOutcome"
- name: Organization
description: "The Organization FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Organization"
- name: OrganizationAffiliation
description: "The OrganizationAffiliation FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation"
- name: Parameters
description: "The Parameters FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Parameters"
- name: Patient
description: "The Patient FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Patient"
- name: PaymentNotice
description: "The PaymentNotice FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/PaymentNotice"
- name: PaymentReconciliation
description: "The PaymentReconciliation FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/PaymentReconciliation"
- name: Person
description: "The Person FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Person"
- name: PlanDefinition
description: "The PlanDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/PlanDefinition"
- name: Practitioner
description: "The Practitioner FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Practitioner"
- name: PractitionerRole
description: "The PractitionerRole FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/PractitionerRole"
- name: Procedure
description: "The Procedure FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Procedure"
- name: Provenance
description: "The Provenance FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Provenance"
- name: Questionnaire
description: "The Questionnaire FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Questionnaire"
- name: QuestionnaireResponse
description: "The QuestionnaireResponse FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"
- name: RelatedPerson
description: "The RelatedPerson FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/RelatedPerson"
- name: RequestGroup
description: "The RequestGroup FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/RequestGroup"
- name: ResearchDefinition
description: "The ResearchDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ResearchDefinition"
- name: ResearchElementDefinition
description: "The ResearchElementDefinition FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition"
- name: ResearchStudy
description: "The ResearchStudy FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ResearchStudy"
- name: ResearchSubject
description: "The ResearchSubject FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ResearchSubject"
- name: RiskAssessment
description: "The RiskAssessment FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/RiskAssessment"
- name: RiskEvidenceSynthesis
description: "The RiskEvidenceSynthesis FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/RiskEvidenceSynthesis"
- name: Schedule
description: "The Schedule FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Schedule"
- name: SearchParameter
description: "The SearchParameter FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/SearchParameter"
- name: ServiceRequest
description: "The ServiceRequest FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ServiceRequest"
- name: Slot
description: "The Slot FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Slot"
- name: Specimen
description: "The Specimen FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Specimen"
- name: SpecimenDefinition
description: "The SpecimenDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/SpecimenDefinition"
- name: StructureDefinition
description: "The StructureDefinition FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/StructureDefinition"
- name: StructureMap
description: "The StructureMap FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/StructureMap"
- name: Subscription
description: "The Subscription FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Subscription"
- name: Substance
description: "The Substance FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Substance"
- name: SubstanceNucleicAcid
description: "The SubstanceNucleicAcid FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/SubstanceNucleicAcid"
- name: SubstancePolymer
description: "The SubstancePolymer FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/SubstancePolymer"
- name: SubstanceProtein
description: "The SubstanceProtein FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/SubstanceProtein"
- name: SubstanceReferenceInformation
description: "The SubstanceReferenceInformation FHIR resource type
Base profile:\
\ http://hl7.org/fhir/StructureDefinition/SubstanceReferenceInformation"
- name: SubstanceSourceMaterial
description: "The SubstanceSourceMaterial FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/SubstanceSourceMaterial"
- name: SubstanceSpecification
description: "The SubstanceSpecification FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/SubstanceSpecification"
- name: SupplyDelivery
description: "The SupplyDelivery FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/SupplyDelivery"
- name: SupplyRequest
description: "The SupplyRequest FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/SupplyRequest"
- name: Task
description: "The Task FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/Task"
- name: TerminologyCapabilities
description: "The TerminologyCapabilities FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/TerminologyCapabilities"
- name: TestReport
description: "The TestReport FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/TestReport"
- name: TestScript
description: "The TestScript FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/TestScript"
- name: ValueSet
description: "The ValueSet FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/ValueSet"
- name: VerificationResult
description: "The VerificationResult FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/VerificationResult"
- name: VisionPrescription
description: "The VisionPrescription FHIR resource type
Base profile: http://hl7.org/fhir/StructureDefinition/VisionPrescription"
paths:
/metadata:
get:
tags:
- System Level Operations
summary: "server-capabilities: Fetch the server FHIR CapabilityStatement"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "CapabilityStatement"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
/:
post:
tags:
- System Level Operations
summary: "server-transaction: Execute a FHIR Transaction (or FHIR Batch) Bundle"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/_history:
get:
tags:
- System Level Operations
summary: "server-history: Fetch the resource change history across all resource\
\ types on the server"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/$diff:
get:
tags:
- System Level Operations
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- System Level Operations
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/$reindex:
post:
tags:
- System Level Operations
summary: "POST: /$reindex"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/$perform-reindexing-pass:
post:
tags:
- System Level Operations
summary: "POST: /$perform-reindexing-pass"
description: Forces a single pass of the resource reindexing processor
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/$meta:
get:
tags:
- System Level Operations
summary: "GET: /$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- System Level Operations
summary: "POST: /$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/$mark-all-resources-for-reindexing:
post:
tags:
- System Level Operations
summary: "POST: /$mark-all-resources-for-reindexing"
description: "Marks all currently existing resources of a given type, or all\
\ resources of all types, for reindexing."
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "type",
"valueCode": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/$get-resource-counts:
get:
tags:
- System Level Operations
summary: "Provides the number of resources currently stored on the server, broken\
\ down by resource type"
description: "Provides the number of resources currently stored on the server,\
\ broken down by resource type"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- System Level Operations
summary: "Provides the number of resources currently stored on the server, broken\
\ down by resource type"
description: "Provides the number of resources currently stored on the server,\
\ broken down by resource type"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/$expunge:
post:
tags:
- System Level Operations
summary: "POST: /$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/$reindex-terminology:
post:
tags:
- System Level Operations
summary: "POST: /$reindex-terminology"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/$hapi.fhir.undo-replace-references:
post:
tags:
- System Level Operations
summary: Restores references from target back to source for resources that were
previously updated by a $hapi.fhir.replace-references operation.
description: This operation undoes the effects of a previous $hapi.fhir.replace-references
operation by restoring references that were replaced from the target back
to the original source.
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-reference-id",
"valueString": "example"
}, {
"name": "target-reference-id",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/$hapi.fhir.replace-references:
post:
tags:
- System Level Operations
summary: Repoints referencing resources to another resources instance
description: This operation searches for all references matching the provided
id and updates them to references to the provided target-reference-id.
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "source-reference-id",
"valueString": "example"
}, {
"name": "target-reference-id",
"valueString": "example"
}, {
"name": "resource-limit"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Account/{id}:
get:
tags:
- Account
summary: "read-instance: Read Account instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Account
summary: "update-instance: Update an existing Account 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": "Account"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Account
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:
- Account
summary: "instance-patch: Patch a resource instance of type Account 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"
/Account/{id}/_history/{version_id}:
get:
tags:
- Account
summary: "vread-instance: Read Account instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Account:
get:
tags:
- Account
summary: "search-type: Search for Account instances"
description: This is a search type
parameters:
- name: owner
in: query
description: Entity managing the Account
required: false
schema:
type: string
- name: identifier
in: query
description: Account number
required: false
schema:
type: string
- name: period
in: query
description: Transaction window
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: The entity that caused the expenses
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: "E.g. patient, expense, depreciation"
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 entity that caused the expenses
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: Human-readable label
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: active | inactive | entered-in-error | on-hold | unknown
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:
- Account
summary: "create-type: Create a new Account instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Account"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Account/_history:
get:
tags:
- Account
summary: "type-history: Fetch the resource change history for all resources\
\ of type Account"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Account/{id}/_history:
get:
tags:
- Account
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Account"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Account/_search:
get:
tags:
- Account
summary: "search-type: Search for Account instances"
description: This is a search type
parameters:
- name: owner
in: query
description: Entity managing the Account
required: false
schema:
type: string
- name: identifier
in: query
description: Account number
required: false
schema:
type: string
- name: period
in: query
description: Transaction window
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: The entity that caused the expenses
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: "E.g. patient, expense, depreciation"
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 entity that caused the expenses
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: Human-readable label
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: active | inactive | entered-in-error | on-hold | unknown
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"
/Account/$validate:
get:
tags:
- Account
summary: "GET: /Account/$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:
- Account
summary: "POST: /Account/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Account",
"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"
/Account/{id}/$validate:
get:
tags:
- Account
summary: "GET: /Account/{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:
- Account
summary: "POST: /Account/{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": "Account",
"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"
/Account/{id}/$meta-delete:
post:
tags:
- Account
summary: "POST: /Account/{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"
/Account/{id}/$meta-add:
post:
tags:
- Account
summary: "POST: /Account/{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"
/Account/$meta:
get:
tags:
- Account
summary: "GET: /Account/$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:
- Account
summary: "POST: /Account/$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"
/Account/{id}/$meta:
get:
tags:
- Account
summary: "GET: /Account/{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:
- Account
summary: "POST: /Account/{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"
/Account/$expunge:
post:
tags:
- Account
summary: "POST: /Account/$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"
/Account/{id}/$expunge:
post:
tags:
- Account
summary: "POST: /Account/{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"
/Account/{id}/$diff:
get:
tags:
- Account
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:
- Account
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"
/ActivityDefinition/{id}:
get:
tags:
- ActivityDefinition
summary: "read-instance: Read ActivityDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ActivityDefinition
summary: "update-instance: Update an existing ActivityDefinition 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": "ActivityDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- ActivityDefinition
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:
- ActivityDefinition
summary: "instance-patch: Patch a resource instance of type ActivityDefinition\
\ 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"
/ActivityDefinition/{id}/_history/{version_id}:
get:
tags:
- ActivityDefinition
summary: "vread-instance: Read ActivityDefinition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ActivityDefinition:
get:
tags:
- ActivityDefinition
summary: "search-type: Search for ActivityDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The activity definition publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the activity definition
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the activity definition
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the activity definition
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the activity definition
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the activity definition
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: A quantity- or range-valued use context assigned to the activity
definition
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the activity definition is intended to
be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the activity definition
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the activity definition
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the activity definition
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: The business version of the activity definition
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the activity definition
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: Computationally friendly name of the activity definition
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the activity definition
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the module
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 activity definition
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:
- ActivityDefinition
summary: "create-type: Create a new ActivityDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ActivityDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ActivityDefinition/_history:
get:
tags:
- ActivityDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type ActivityDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ActivityDefinition/{id}/_history:
get:
tags:
- ActivityDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ActivityDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ActivityDefinition/_search:
get:
tags:
- ActivityDefinition
summary: "search-type: Search for ActivityDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The activity definition publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the activity definition
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the activity definition
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the activity definition
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the activity definition
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the activity definition
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: A quantity- or range-valued use context assigned to the activity
definition
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the activity definition is intended to
be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the activity definition
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the activity definition
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the activity definition
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: The business version of the activity definition
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the activity definition
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: Computationally friendly name of the activity definition
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the activity definition
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the module
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 activity definition
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"
/ActivityDefinition/$validate:
get:
tags:
- ActivityDefinition
summary: "GET: /ActivityDefinition/$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:
- ActivityDefinition
summary: "POST: /ActivityDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ActivityDefinition",
"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"
/ActivityDefinition/{id}/$validate:
get:
tags:
- ActivityDefinition
summary: "GET: /ActivityDefinition/{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:
- ActivityDefinition
summary: "POST: /ActivityDefinition/{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": "ActivityDefinition",
"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"
/ActivityDefinition/{id}/$meta-delete:
post:
tags:
- ActivityDefinition
summary: "POST: /ActivityDefinition/{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"
/ActivityDefinition/{id}/$meta-add:
post:
tags:
- ActivityDefinition
summary: "POST: /ActivityDefinition/{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"
/ActivityDefinition/$meta:
get:
tags:
- ActivityDefinition
summary: "GET: /ActivityDefinition/$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:
- ActivityDefinition
summary: "POST: /ActivityDefinition/$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"
/ActivityDefinition/{id}/$meta:
get:
tags:
- ActivityDefinition
summary: "GET: /ActivityDefinition/{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:
- ActivityDefinition
summary: "POST: /ActivityDefinition/{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"
/ActivityDefinition/$expunge:
post:
tags:
- ActivityDefinition
summary: "POST: /ActivityDefinition/$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"
/ActivityDefinition/{id}/$expunge:
post:
tags:
- ActivityDefinition
summary: "POST: /ActivityDefinition/{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"
/ActivityDefinition/{id}/$diff:
get:
tags:
- ActivityDefinition
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:
- ActivityDefinition
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"
/AdverseEvent/{id}:
get:
tags:
- AdverseEvent
summary: "read-instance: Read AdverseEvent instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- AdverseEvent
summary: "update-instance: Update an existing AdverseEvent 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": "AdverseEvent"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- AdverseEvent
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:
- AdverseEvent
summary: "instance-patch: Patch a resource instance of type AdverseEvent 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"
/AdverseEvent/{id}/_history/{version_id}:
get:
tags:
- AdverseEvent
summary: "vread-instance: Read AdverseEvent instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AdverseEvent:
get:
tags:
- AdverseEvent
summary: "search-type: Search for AdverseEvent instances"
description: This is a search type
parameters:
- name: date
in: query
description: When the event occurred
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: severity
in: query
description: mild | moderate | severe
required: false
schema:
type: string
- name: recorder
in: query
description: Who recorded the adverse event
required: false
schema:
type: string
- name: study
in: query
description: AdverseEvent.study
required: false
schema:
type: string
- name: actuality
in: query
description: actual | potential
required: false
schema:
type: string
- name: subject
in: query
description: Subject impacted by event
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: resultingcondition
in: query
description: Effect on the subject due to this event
required: false
schema:
type: string
- name: substance
in: query
description: Refers to the specific entity that caused the adverse event
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _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: seriousness
in: query
description: Seriousness of the event
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: location
in: query
description: Location where adverse event occurred
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: product-problem | product-quality | product-use-error | wrong-dose
| incorrect-prescribing-information | wrong-technique | wrong-route-of-administration
| wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device-use-error
| problem-different-manufacturer | unsafe-physical-environment
required: false
schema:
type: string
- name: event
in: query
description: Type of the event itself in relation to the subject
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:
- AdverseEvent
summary: "create-type: Create a new AdverseEvent instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "AdverseEvent"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AdverseEvent/_history:
get:
tags:
- AdverseEvent
summary: "type-history: Fetch the resource change history for all resources\
\ of type AdverseEvent"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AdverseEvent/{id}/_history:
get:
tags:
- AdverseEvent
summary: "instance-history: Fetch the resource change history for all resources\
\ of type AdverseEvent"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AdverseEvent/_search:
get:
tags:
- AdverseEvent
summary: "search-type: Search for AdverseEvent instances"
description: This is a search type
parameters:
- name: date
in: query
description: When the event occurred
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: severity
in: query
description: mild | moderate | severe
required: false
schema:
type: string
- name: recorder
in: query
description: Who recorded the adverse event
required: false
schema:
type: string
- name: study
in: query
description: AdverseEvent.study
required: false
schema:
type: string
- name: actuality
in: query
description: actual | potential
required: false
schema:
type: string
- name: subject
in: query
description: Subject impacted by event
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: resultingcondition
in: query
description: Effect on the subject due to this event
required: false
schema:
type: string
- name: substance
in: query
description: Refers to the specific entity that caused the adverse event
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _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: seriousness
in: query
description: Seriousness of the event
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: location
in: query
description: Location where adverse event occurred
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: product-problem | product-quality | product-use-error | wrong-dose
| incorrect-prescribing-information | wrong-technique | wrong-route-of-administration
| wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device-use-error
| problem-different-manufacturer | unsafe-physical-environment
required: false
schema:
type: string
- name: event
in: query
description: Type of the event itself in relation to the subject
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"
/AdverseEvent/$validate:
get:
tags:
- AdverseEvent
summary: "GET: /AdverseEvent/$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:
- AdverseEvent
summary: "POST: /AdverseEvent/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "AdverseEvent",
"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"
/AdverseEvent/{id}/$validate:
get:
tags:
- AdverseEvent
summary: "GET: /AdverseEvent/{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:
- AdverseEvent
summary: "POST: /AdverseEvent/{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": "AdverseEvent",
"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"
/AdverseEvent/{id}/$meta-delete:
post:
tags:
- AdverseEvent
summary: "POST: /AdverseEvent/{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"
/AdverseEvent/{id}/$meta-add:
post:
tags:
- AdverseEvent
summary: "POST: /AdverseEvent/{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"
/AdverseEvent/$meta:
get:
tags:
- AdverseEvent
summary: "GET: /AdverseEvent/$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:
- AdverseEvent
summary: "POST: /AdverseEvent/$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"
/AdverseEvent/{id}/$meta:
get:
tags:
- AdverseEvent
summary: "GET: /AdverseEvent/{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:
- AdverseEvent
summary: "POST: /AdverseEvent/{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"
/AdverseEvent/$expunge:
post:
tags:
- AdverseEvent
summary: "POST: /AdverseEvent/$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"
/AdverseEvent/{id}/$expunge:
post:
tags:
- AdverseEvent
summary: "POST: /AdverseEvent/{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"
/AdverseEvent/{id}/$diff:
get:
tags:
- AdverseEvent
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:
- AdverseEvent
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"
/AllergyIntolerance/{id}:
get:
tags:
- AllergyIntolerance
summary: "read-instance: Read AllergyIntolerance instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- AllergyIntolerance
summary: "update-instance: Update an existing AllergyIntolerance 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": "AllergyIntolerance"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- AllergyIntolerance
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:
- AllergyIntolerance
summary: "instance-patch: Patch a resource instance of type AllergyIntolerance\
\ 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"
/AllergyIntolerance/{id}/_history/{version_id}:
get:
tags:
- AllergyIntolerance
summary: "vread-instance: Read AllergyIntolerance instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AllergyIntolerance:
get:
tags:
- AllergyIntolerance
summary: "search-type: Search for AllergyIntolerance instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
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: verification-status
in: query
description: unconfirmed | confirmed | refuted | entered-in-error
required: false
schema:
type: string
- name: criticality
in: query
description: low | high | unable-to-assess
required: false
schema:
type: string
- name: clinical-status
in: query
description: active | inactive | resolved
required: false
schema:
type: string
- name: type
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html):\
\ Kind of document set\r\n* [DocumentReference](documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class\
\ - e.g. specialist referral, disease management"
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: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: severity
in: query
description: mild | moderate | severe (of event as a whole)
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: manifestation
in: query
description: Clinical symptoms/signs associated with the Event
required: false
schema:
type: string
- name: recorder
in: query
description: Who recorded the sensitivity
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: onset
in: query
description: Date(/time) when manifestations showed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: asserter
in: query
description: Source of the information about the allergy
required: false
schema:
type: string
- name: route
in: query
description: How the subject was exposed to the substance
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: food | medication | environment | biologic
required: false
schema:
type: string
- name: last-date
in: query
description: Date(/time) of last known occurrence of a reaction
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- AllergyIntolerance
summary: "create-type: Create a new AllergyIntolerance instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "AllergyIntolerance"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AllergyIntolerance/_history:
get:
tags:
- AllergyIntolerance
summary: "type-history: Fetch the resource change history for all resources\
\ of type AllergyIntolerance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AllergyIntolerance/{id}/_history:
get:
tags:
- AllergyIntolerance
summary: "instance-history: Fetch the resource change history for all resources\
\ of type AllergyIntolerance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AllergyIntolerance/_search:
get:
tags:
- AllergyIntolerance
summary: "search-type: Search for AllergyIntolerance instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
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: verification-status
in: query
description: unconfirmed | confirmed | refuted | entered-in-error
required: false
schema:
type: string
- name: criticality
in: query
description: low | high | unable-to-assess
required: false
schema:
type: string
- name: clinical-status
in: query
description: active | inactive | resolved
required: false
schema:
type: string
- name: type
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html):\
\ Kind of document set\r\n* [DocumentReference](documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class\
\ - e.g. specialist referral, disease management"
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: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: severity
in: query
description: mild | moderate | severe (of event as a whole)
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: manifestation
in: query
description: Clinical symptoms/signs associated with the Event
required: false
schema:
type: string
- name: recorder
in: query
description: Who recorded the sensitivity
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: onset
in: query
description: Date(/time) when manifestations showed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: asserter
in: query
description: Source of the information about the allergy
required: false
schema:
type: string
- name: route
in: query
description: How the subject was exposed to the substance
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: food | medication | environment | biologic
required: false
schema:
type: string
- name: last-date
in: query
description: Date(/time) of last known occurrence of a reaction
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AllergyIntolerance/$validate:
get:
tags:
- AllergyIntolerance
summary: "GET: /AllergyIntolerance/$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:
- AllergyIntolerance
summary: "POST: /AllergyIntolerance/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "AllergyIntolerance",
"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"
/AllergyIntolerance/{id}/$validate:
get:
tags:
- AllergyIntolerance
summary: "GET: /AllergyIntolerance/{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:
- AllergyIntolerance
summary: "POST: /AllergyIntolerance/{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": "AllergyIntolerance",
"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"
/AllergyIntolerance/{id}/$meta-delete:
post:
tags:
- AllergyIntolerance
summary: "POST: /AllergyIntolerance/{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"
/AllergyIntolerance/{id}/$meta-add:
post:
tags:
- AllergyIntolerance
summary: "POST: /AllergyIntolerance/{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"
/AllergyIntolerance/$meta:
get:
tags:
- AllergyIntolerance
summary: "GET: /AllergyIntolerance/$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:
- AllergyIntolerance
summary: "POST: /AllergyIntolerance/$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"
/AllergyIntolerance/{id}/$meta:
get:
tags:
- AllergyIntolerance
summary: "GET: /AllergyIntolerance/{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:
- AllergyIntolerance
summary: "POST: /AllergyIntolerance/{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"
/AllergyIntolerance/$expunge:
post:
tags:
- AllergyIntolerance
summary: "POST: /AllergyIntolerance/$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"
/AllergyIntolerance/{id}/$expunge:
post:
tags:
- AllergyIntolerance
summary: "POST: /AllergyIntolerance/{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"
/AllergyIntolerance/{id}/$diff:
get:
tags:
- AllergyIntolerance
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:
- AllergyIntolerance
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"
/Appointment/{id}:
get:
tags:
- Appointment
summary: "read-instance: Read Appointment instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Appointment
summary: "update-instance: Update an existing Appointment 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": "Appointment"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Appointment
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:
- Appointment
summary: "instance-patch: Patch a resource instance of type Appointment 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"
/Appointment/{id}/_history/{version_id}:
get:
tags:
- Appointment
summary: "vread-instance: Read Appointment instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Appointment:
get:
tags:
- Appointment
summary: "search-type: Search for Appointment instances"
description: This is a search type
parameters:
- name: date
in: query
description: Appointment date/time.
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: specialty
in: query
description: The specialty of a practitioner that would be required to perform
the service requested in this appointment
required: false
schema:
type: string
- name: service-category
in: query
description: A broad categorization of the service that is to be performed
during this appointment
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: slot
in: query
description: The slots that this appointment is filling
required: false
schema:
type: string
- name: reason-code
in: query
description: Coded reason this appointment is scheduled
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 service request this appointment is allocated to assess
required: false
schema:
type: string
- name: patient
in: query
description: One of the individuals of the appointment is this patient
required: false
schema:
type: string
- name: supporting-info
in: query
description: Additional information to support the appointment
required: false
schema:
type: string
- name: identifier
in: query
description: An Identifier of the Appointment
required: false
schema:
type: string
- name: practitioner
in: query
description: One of the individuals of the appointment is this practitioner
required: false
schema:
type: string
- name: appointment-type
in: query
description: The style of appointment or patient that has been booked in the
slot (not service type)
required: false
schema:
type: string
- name: part-status
in: query
description: "The Participation status of the subject, or other participant\
\ on the appointment. Can be used to locate participants that have not responded\
\ to meeting requests."
required: false
schema:
type: string
- name: service-type
in: query
description: The specific service that is to be performed during this appointment
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: actor
in: query
description: Any one of the individuals participating in the appointment
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: Reason the appointment is to take place (resource)
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: This location is listed in the participants of the appointment
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 overall status of the appointment
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:
- Appointment
summary: "create-type: Create a new Appointment instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Appointment"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Appointment/_history:
get:
tags:
- Appointment
summary: "type-history: Fetch the resource change history for all resources\
\ of type Appointment"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Appointment/{id}/_history:
get:
tags:
- Appointment
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Appointment"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Appointment/_search:
get:
tags:
- Appointment
summary: "search-type: Search for Appointment instances"
description: This is a search type
parameters:
- name: date
in: query
description: Appointment date/time.
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: specialty
in: query
description: The specialty of a practitioner that would be required to perform
the service requested in this appointment
required: false
schema:
type: string
- name: service-category
in: query
description: A broad categorization of the service that is to be performed
during this appointment
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: slot
in: query
description: The slots that this appointment is filling
required: false
schema:
type: string
- name: reason-code
in: query
description: Coded reason this appointment is scheduled
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 service request this appointment is allocated to assess
required: false
schema:
type: string
- name: patient
in: query
description: One of the individuals of the appointment is this patient
required: false
schema:
type: string
- name: supporting-info
in: query
description: Additional information to support the appointment
required: false
schema:
type: string
- name: identifier
in: query
description: An Identifier of the Appointment
required: false
schema:
type: string
- name: practitioner
in: query
description: One of the individuals of the appointment is this practitioner
required: false
schema:
type: string
- name: appointment-type
in: query
description: The style of appointment or patient that has been booked in the
slot (not service type)
required: false
schema:
type: string
- name: part-status
in: query
description: "The Participation status of the subject, or other participant\
\ on the appointment. Can be used to locate participants that have not responded\
\ to meeting requests."
required: false
schema:
type: string
- name: service-type
in: query
description: The specific service that is to be performed during this appointment
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: actor
in: query
description: Any one of the individuals participating in the appointment
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: Reason the appointment is to take place (resource)
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: This location is listed in the participants of the appointment
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 overall status of the appointment
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"
/Appointment/$validate:
get:
tags:
- Appointment
summary: "GET: /Appointment/$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:
- Appointment
summary: "POST: /Appointment/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Appointment",
"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"
/Appointment/{id}/$validate:
get:
tags:
- Appointment
summary: "GET: /Appointment/{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:
- Appointment
summary: "POST: /Appointment/{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": "Appointment",
"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"
/Appointment/{id}/$meta-delete:
post:
tags:
- Appointment
summary: "POST: /Appointment/{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"
/Appointment/{id}/$meta-add:
post:
tags:
- Appointment
summary: "POST: /Appointment/{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"
/Appointment/$meta:
get:
tags:
- Appointment
summary: "GET: /Appointment/$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:
- Appointment
summary: "POST: /Appointment/$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"
/Appointment/{id}/$meta:
get:
tags:
- Appointment
summary: "GET: /Appointment/{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:
- Appointment
summary: "POST: /Appointment/{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"
/Appointment/$expunge:
post:
tags:
- Appointment
summary: "POST: /Appointment/$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"
/Appointment/{id}/$expunge:
post:
tags:
- Appointment
summary: "POST: /Appointment/{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"
/Appointment/{id}/$diff:
get:
tags:
- Appointment
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:
- Appointment
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"
/AppointmentResponse/{id}:
get:
tags:
- AppointmentResponse
summary: "read-instance: Read AppointmentResponse instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- AppointmentResponse
summary: "update-instance: Update an existing AppointmentResponse 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": "AppointmentResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- AppointmentResponse
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:
- AppointmentResponse
summary: "instance-patch: Patch a resource instance of type AppointmentResponse\
\ 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"
/AppointmentResponse/{id}/_history/{version_id}:
get:
tags:
- AppointmentResponse
summary: "vread-instance: Read AppointmentResponse instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AppointmentResponse:
get:
tags:
- AppointmentResponse
summary: "search-type: Search for AppointmentResponse instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: An Identifier in this appointment response
required: false
schema:
type: string
- name: practitioner
in: query
description: This Response is for this Practitioner
required: false
schema:
type: string
- name: part-status
in: query
description: The participants acceptance status for this appointment
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: appointment
in: query
description: The appointment that the response is attached to
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: actor
in: query
description: "The Person, Location/HealthcareService or Device that this appointment\
\ response replies for"
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: This Response is for this Patient
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: location
in: query
description: This Response is for this Location
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
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:
- AppointmentResponse
summary: "create-type: Create a new AppointmentResponse instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "AppointmentResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AppointmentResponse/_history:
get:
tags:
- AppointmentResponse
summary: "type-history: Fetch the resource change history for all resources\
\ of type AppointmentResponse"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AppointmentResponse/{id}/_history:
get:
tags:
- AppointmentResponse
summary: "instance-history: Fetch the resource change history for all resources\
\ of type AppointmentResponse"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AppointmentResponse/_search:
get:
tags:
- AppointmentResponse
summary: "search-type: Search for AppointmentResponse instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: An Identifier in this appointment response
required: false
schema:
type: string
- name: practitioner
in: query
description: This Response is for this Practitioner
required: false
schema:
type: string
- name: part-status
in: query
description: The participants acceptance status for this appointment
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: appointment
in: query
description: The appointment that the response is attached to
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: actor
in: query
description: "The Person, Location/HealthcareService or Device that this appointment\
\ response replies for"
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: This Response is for this Patient
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: location
in: query
description: This Response is for this Location
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
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"
/AppointmentResponse/$validate:
get:
tags:
- AppointmentResponse
summary: "GET: /AppointmentResponse/$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:
- AppointmentResponse
summary: "POST: /AppointmentResponse/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "AppointmentResponse",
"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"
/AppointmentResponse/{id}/$validate:
get:
tags:
- AppointmentResponse
summary: "GET: /AppointmentResponse/{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:
- AppointmentResponse
summary: "POST: /AppointmentResponse/{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": "AppointmentResponse",
"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"
/AppointmentResponse/{id}/$meta-delete:
post:
tags:
- AppointmentResponse
summary: "POST: /AppointmentResponse/{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"
/AppointmentResponse/{id}/$meta-add:
post:
tags:
- AppointmentResponse
summary: "POST: /AppointmentResponse/{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"
/AppointmentResponse/$meta:
get:
tags:
- AppointmentResponse
summary: "GET: /AppointmentResponse/$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:
- AppointmentResponse
summary: "POST: /AppointmentResponse/$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"
/AppointmentResponse/{id}/$meta:
get:
tags:
- AppointmentResponse
summary: "GET: /AppointmentResponse/{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:
- AppointmentResponse
summary: "POST: /AppointmentResponse/{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"
/AppointmentResponse/$expunge:
post:
tags:
- AppointmentResponse
summary: "POST: /AppointmentResponse/$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"
/AppointmentResponse/{id}/$expunge:
post:
tags:
- AppointmentResponse
summary: "POST: /AppointmentResponse/{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"
/AppointmentResponse/{id}/$diff:
get:
tags:
- AppointmentResponse
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:
- AppointmentResponse
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/{id}:
get:
tags:
- AuditEvent
summary: "read-instance: Read AuditEvent instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- AuditEvent
summary: "update-instance: Update an existing AuditEvent instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "AuditEvent"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- AuditEvent
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- AuditEvent
summary: "instance-patch: Patch a resource instance of type AuditEvent by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/{id}/_history/{version_id}:
get:
tags:
- AuditEvent
summary: "vread-instance: Read AuditEvent instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent:
get:
tags:
- AuditEvent
summary: "search-type: Search for AuditEvent instances"
description: This is a search type
parameters:
- name: date
in: query
description: Time when the event was recorded
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: entity-type
in: query
description: Type of entity involved
required: false
schema:
type: string
- name: agent
in: query
description: Identifier of who
required: false
schema:
type: string
- name: entity-role
in: query
description: What role the entity played
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: source
in: query
description: The identity of source detecting the event
required: false
schema:
type: string
- name: type
in: query
description: Type/identifier of event
required: false
schema:
type: string
- name: altid
in: query
description: Alternative User identity
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: agent-name
in: query
description: Human friendly name for the agent
required: false
schema:
type: string
- name: entity-name
in: query
description: Descriptor for entity
required: false
schema:
type: string
- name: subtype
in: query
description: More specific type/id for the event
required: false
schema:
type: string
- name: patient
in: query
description: Identifier of who
required: false
schema:
type: string
- name: action
in: query
description: Type of action performed during the event
required: false
schema:
type: string
- name: outcome
in: query
description: Whether the event succeeded or failed
required: false
schema:
type: string
- name: policy
in: query
description: Policy that authorized event
required: false
schema:
type: string
- name: address
in: query
description: Identifier for the network access point of the user device
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: site
in: query
description: Logical source location within the enterprise
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: agent-role
in: query
description: Agent role in the event
required: false
schema:
type: string
- name: entity
in: query
description: Specific instance of resource
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- AuditEvent
summary: "create-type: Create a new AuditEvent instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "AuditEvent"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/_history:
get:
tags:
- AuditEvent
summary: "type-history: Fetch the resource change history for all resources\
\ of type AuditEvent"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/{id}/_history:
get:
tags:
- AuditEvent
summary: "instance-history: Fetch the resource change history for all resources\
\ of type AuditEvent"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/_search:
get:
tags:
- AuditEvent
summary: "search-type: Search for AuditEvent instances"
description: This is a search type
parameters:
- name: date
in: query
description: Time when the event was recorded
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: entity-type
in: query
description: Type of entity involved
required: false
schema:
type: string
- name: agent
in: query
description: Identifier of who
required: false
schema:
type: string
- name: entity-role
in: query
description: What role the entity played
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: source
in: query
description: The identity of source detecting the event
required: false
schema:
type: string
- name: type
in: query
description: Type/identifier of event
required: false
schema:
type: string
- name: altid
in: query
description: Alternative User identity
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: agent-name
in: query
description: Human friendly name for the agent
required: false
schema:
type: string
- name: entity-name
in: query
description: Descriptor for entity
required: false
schema:
type: string
- name: subtype
in: query
description: More specific type/id for the event
required: false
schema:
type: string
- name: patient
in: query
description: Identifier of who
required: false
schema:
type: string
- name: action
in: query
description: Type of action performed during the event
required: false
schema:
type: string
- name: outcome
in: query
description: Whether the event succeeded or failed
required: false
schema:
type: string
- name: policy
in: query
description: Policy that authorized event
required: false
schema:
type: string
- name: address
in: query
description: Identifier for the network access point of the user device
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: site
in: query
description: Logical source location within the enterprise
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: agent-role
in: query
description: Agent role in the event
required: false
schema:
type: string
- name: entity
in: query
description: Specific instance of resource
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/$validate:
get:
tags:
- AuditEvent
summary: "GET: /AuditEvent/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "AuditEvent",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/{id}/$validate:
get:
tags:
- AuditEvent
summary: "GET: /AuditEvent/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "AuditEvent",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/{id}/$meta-delete:
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/{id}/$meta-add:
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/$meta:
get:
tags:
- AuditEvent
summary: "GET: /AuditEvent/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/{id}/$meta:
get:
tags:
- AuditEvent
summary: "GET: /AuditEvent/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/$expunge:
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/{id}/$expunge:
post:
tags:
- AuditEvent
summary: "POST: /AuditEvent/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/AuditEvent/{id}/$diff:
get:
tags:
- AuditEvent
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- AuditEvent
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Basic/{id}:
get:
tags:
- Basic
summary: "read-instance: Read Basic instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Basic
summary: "update-instance: Update an existing Basic 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": "Basic"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Basic
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:
- Basic
summary: "instance-patch: Patch a resource instance of type Basic 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"
/Basic/{id}/_history/{version_id}:
get:
tags:
- Basic
summary: "vread-instance: Read Basic instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Basic:
get:
tags:
- Basic
summary: "search-type: Search for Basic instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Business identifier
required: false
schema:
type: string
- name: code
in: query
description: Kind of Resource
required: false
schema:
type: string
- name: author
in: query
description: Who created
required: false
schema:
type: string
- name: created
in: query
description: When created
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: Identifies the focus of this resource
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: Identifies the focus of this resource
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Basic
summary: "create-type: Create a new Basic instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Basic"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Basic/_history:
get:
tags:
- Basic
summary: "type-history: Fetch the resource change history for all resources\
\ of type Basic"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Basic/{id}/_history:
get:
tags:
- Basic
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Basic"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Basic/_search:
get:
tags:
- Basic
summary: "search-type: Search for Basic instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Business identifier
required: false
schema:
type: string
- name: code
in: query
description: Kind of Resource
required: false
schema:
type: string
- name: author
in: query
description: Who created
required: false
schema:
type: string
- name: created
in: query
description: When created
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: Identifies the focus of this resource
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: Identifies the focus of this resource
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Basic/$validate:
get:
tags:
- Basic
summary: "GET: /Basic/$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:
- Basic
summary: "POST: /Basic/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Basic",
"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"
/Basic/{id}/$validate:
get:
tags:
- Basic
summary: "GET: /Basic/{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:
- Basic
summary: "POST: /Basic/{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": "Basic",
"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"
/Basic/{id}/$meta-delete:
post:
tags:
- Basic
summary: "POST: /Basic/{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"
/Basic/{id}/$meta-add:
post:
tags:
- Basic
summary: "POST: /Basic/{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"
/Basic/$meta:
get:
tags:
- Basic
summary: "GET: /Basic/$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:
- Basic
summary: "POST: /Basic/$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"
/Basic/{id}/$meta:
get:
tags:
- Basic
summary: "GET: /Basic/{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:
- Basic
summary: "POST: /Basic/{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"
/Basic/$expunge:
post:
tags:
- Basic
summary: "POST: /Basic/$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"
/Basic/{id}/$expunge:
post:
tags:
- Basic
summary: "POST: /Basic/{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"
/Basic/{id}/$diff:
get:
tags:
- Basic
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:
- Basic
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"
/Binary/{id}:
get:
tags:
- Binary
summary: "read-instance: Read Binary instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Binary
summary: "update-instance: Update an existing Binary 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": "Binary"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Binary
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:
- Binary
summary: "instance-patch: Patch a resource instance of type Binary 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"
/Binary/{id}/_history/{version_id}:
get:
tags:
- Binary
summary: "vread-instance: Read Binary instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Binary:
get:
tags:
- Binary
summary: "search-type: Search for Binary instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- Binary
summary: "create-type: Create a new Binary instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Binary"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Binary/_history:
get:
tags:
- Binary
summary: "type-history: Fetch the resource change history for all resources\
\ of type Binary"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Binary/{id}/_history:
get:
tags:
- Binary
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Binary"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Binary/_search:
get:
tags:
- Binary
summary: "search-type: Search for Binary instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/Binary/$validate:
get:
tags:
- Binary
summary: "GET: /Binary/$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:
- Binary
summary: "POST: /Binary/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Binary",
"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"
/Binary/{id}/$validate:
get:
tags:
- Binary
summary: "GET: /Binary/{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:
- Binary
summary: "POST: /Binary/{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": "Binary",
"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"
/Binary/{id}/$meta-delete:
post:
tags:
- Binary
summary: "POST: /Binary/{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"
/Binary/{id}/$meta-add:
post:
tags:
- Binary
summary: "POST: /Binary/{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"
/Binary/$meta:
get:
tags:
- Binary
summary: "GET: /Binary/$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:
- Binary
summary: "POST: /Binary/$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"
/Binary/{id}/$meta:
get:
tags:
- Binary
summary: "GET: /Binary/{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:
- Binary
summary: "POST: /Binary/{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"
/Binary/$expunge:
post:
tags:
- Binary
summary: "POST: /Binary/$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"
/Binary/{id}/$expunge:
post:
tags:
- Binary
summary: "POST: /Binary/{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"
/Binary/{id}/$diff:
get:
tags:
- Binary
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:
- Binary
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"
/BiologicallyDerivedProduct/{id}:
get:
tags:
- BiologicallyDerivedProduct
summary: "read-instance: Read BiologicallyDerivedProduct instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- BiologicallyDerivedProduct
summary: "update-instance: Update an existing BiologicallyDerivedProduct 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": "BiologicallyDerivedProduct"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- BiologicallyDerivedProduct
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:
- BiologicallyDerivedProduct
summary: "instance-patch: Patch a resource instance of type BiologicallyDerivedProduct\
\ 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"
/BiologicallyDerivedProduct/{id}/_history/{version_id}:
get:
tags:
- BiologicallyDerivedProduct
summary: "vread-instance: Read BiologicallyDerivedProduct instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/BiologicallyDerivedProduct:
get:
tags:
- BiologicallyDerivedProduct
summary: "search-type: Search for BiologicallyDerivedProduct instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- BiologicallyDerivedProduct
summary: "create-type: Create a new BiologicallyDerivedProduct instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "BiologicallyDerivedProduct"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/BiologicallyDerivedProduct/_history:
get:
tags:
- BiologicallyDerivedProduct
summary: "type-history: Fetch the resource change history for all resources\
\ of type BiologicallyDerivedProduct"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/BiologicallyDerivedProduct/{id}/_history:
get:
tags:
- BiologicallyDerivedProduct
summary: "instance-history: Fetch the resource change history for all resources\
\ of type BiologicallyDerivedProduct"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/BiologicallyDerivedProduct/_search:
get:
tags:
- BiologicallyDerivedProduct
summary: "search-type: Search for BiologicallyDerivedProduct instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/BiologicallyDerivedProduct/$validate:
get:
tags:
- BiologicallyDerivedProduct
summary: "GET: /BiologicallyDerivedProduct/$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:
- BiologicallyDerivedProduct
summary: "POST: /BiologicallyDerivedProduct/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "BiologicallyDerivedProduct",
"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"
/BiologicallyDerivedProduct/{id}/$validate:
get:
tags:
- BiologicallyDerivedProduct
summary: "GET: /BiologicallyDerivedProduct/{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:
- BiologicallyDerivedProduct
summary: "POST: /BiologicallyDerivedProduct/{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": "BiologicallyDerivedProduct",
"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"
/BiologicallyDerivedProduct/{id}/$meta-delete:
post:
tags:
- BiologicallyDerivedProduct
summary: "POST: /BiologicallyDerivedProduct/{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"
/BiologicallyDerivedProduct/{id}/$meta-add:
post:
tags:
- BiologicallyDerivedProduct
summary: "POST: /BiologicallyDerivedProduct/{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"
/BiologicallyDerivedProduct/$meta:
get:
tags:
- BiologicallyDerivedProduct
summary: "GET: /BiologicallyDerivedProduct/$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:
- BiologicallyDerivedProduct
summary: "POST: /BiologicallyDerivedProduct/$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"
/BiologicallyDerivedProduct/{id}/$meta:
get:
tags:
- BiologicallyDerivedProduct
summary: "GET: /BiologicallyDerivedProduct/{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:
- BiologicallyDerivedProduct
summary: "POST: /BiologicallyDerivedProduct/{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"
/BiologicallyDerivedProduct/$expunge:
post:
tags:
- BiologicallyDerivedProduct
summary: "POST: /BiologicallyDerivedProduct/$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"
/BiologicallyDerivedProduct/{id}/$expunge:
post:
tags:
- BiologicallyDerivedProduct
summary: "POST: /BiologicallyDerivedProduct/{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"
/BiologicallyDerivedProduct/{id}/$diff:
get:
tags:
- BiologicallyDerivedProduct
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:
- BiologicallyDerivedProduct
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"
/BodyStructure/{id}:
get:
tags:
- BodyStructure
summary: "read-instance: Read BodyStructure instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- BodyStructure
summary: "update-instance: Update an existing BodyStructure 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": "BodyStructure"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- BodyStructure
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:
- BodyStructure
summary: "instance-patch: Patch a resource instance of type BodyStructure 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"
/BodyStructure/{id}/_history/{version_id}:
get:
tags:
- BodyStructure
summary: "vread-instance: Read BodyStructure instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/BodyStructure:
get:
tags:
- BodyStructure
summary: "search-type: Search for BodyStructure instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Bodystructure identifier
required: false
schema:
type: string
- name: morphology
in: query
description: Kind of Structure
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: Who this is about
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: location
in: query
description: Body site
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
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:
- BodyStructure
summary: "create-type: Create a new BodyStructure instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "BodyStructure"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/BodyStructure/_history:
get:
tags:
- BodyStructure
summary: "type-history: Fetch the resource change history for all resources\
\ of type BodyStructure"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/BodyStructure/{id}/_history:
get:
tags:
- BodyStructure
summary: "instance-history: Fetch the resource change history for all resources\
\ of type BodyStructure"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/BodyStructure/_search:
get:
tags:
- BodyStructure
summary: "search-type: Search for BodyStructure instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Bodystructure identifier
required: false
schema:
type: string
- name: morphology
in: query
description: Kind of Structure
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: Who this is about
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: location
in: query
description: Body site
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
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"
/BodyStructure/$validate:
get:
tags:
- BodyStructure
summary: "GET: /BodyStructure/$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:
- BodyStructure
summary: "POST: /BodyStructure/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "BodyStructure",
"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"
/BodyStructure/{id}/$validate:
get:
tags:
- BodyStructure
summary: "GET: /BodyStructure/{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:
- BodyStructure
summary: "POST: /BodyStructure/{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": "BodyStructure",
"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"
/BodyStructure/{id}/$meta-delete:
post:
tags:
- BodyStructure
summary: "POST: /BodyStructure/{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"
/BodyStructure/{id}/$meta-add:
post:
tags:
- BodyStructure
summary: "POST: /BodyStructure/{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"
/BodyStructure/$meta:
get:
tags:
- BodyStructure
summary: "GET: /BodyStructure/$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:
- BodyStructure
summary: "POST: /BodyStructure/$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"
/BodyStructure/{id}/$meta:
get:
tags:
- BodyStructure
summary: "GET: /BodyStructure/{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:
- BodyStructure
summary: "POST: /BodyStructure/{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"
/BodyStructure/$expunge:
post:
tags:
- BodyStructure
summary: "POST: /BodyStructure/$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"
/BodyStructure/{id}/$expunge:
post:
tags:
- BodyStructure
summary: "POST: /BodyStructure/{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"
/BodyStructure/{id}/$diff:
get:
tags:
- BodyStructure
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:
- BodyStructure
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"
/Bundle/{id}:
get:
tags:
- Bundle
summary: "read-instance: Read Bundle instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Bundle
summary: "update-instance: Update an existing Bundle 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": "Bundle"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Bundle
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:
- Bundle
summary: "instance-patch: Patch a resource instance of type Bundle 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"
/Bundle/{id}/_history/{version_id}:
get:
tags:
- Bundle
summary: "vread-instance: Read Bundle instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Bundle:
get:
tags:
- Bundle
summary: "search-type: Search for Bundle instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Persistent identifier for the bundle
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: message
in: query
description: "The first resource in the bundle, if the bundle type is \"message\"\
\ - this is a message header, and this parameter provides access to search\
\ its contents"
required: false
schema:
type: string
- name: type
in: query
description: document | message | transaction | transaction-response | batch
| batch-response | history | searchset | collection
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: composition
in: query
description: "The first resource in the bundle, if the bundle type is \"document\"\
\ - this is a composition, and this parameter provides access to search\
\ its contents"
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: timestamp
in: query
description: When the bundle was assembled
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Bundle
summary: "create-type: Create a new Bundle instance"
requestBody:
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:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Bundle/_history:
get:
tags:
- Bundle
summary: "type-history: Fetch the resource change history for all resources\
\ of type Bundle"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Bundle/{id}/_history:
get:
tags:
- Bundle
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Bundle"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Bundle/_search:
get:
tags:
- Bundle
summary: "search-type: Search for Bundle instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Persistent identifier for the bundle
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: message
in: query
description: "The first resource in the bundle, if the bundle type is \"message\"\
\ - this is a message header, and this parameter provides access to search\
\ its contents"
required: false
schema:
type: string
- name: type
in: query
description: document | message | transaction | transaction-response | batch
| batch-response | history | searchset | collection
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: composition
in: query
description: "The first resource in the bundle, if the bundle type is \"document\"\
\ - this is a composition, and this parameter provides access to search\
\ its contents"
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: timestamp
in: query
description: When the bundle was assembled
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Bundle/$validate:
get:
tags:
- Bundle
summary: "GET: /Bundle/$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:
- Bundle
summary: "POST: /Bundle/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Bundle",
"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"
/Bundle/{id}/$validate:
get:
tags:
- Bundle
summary: "GET: /Bundle/{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:
- Bundle
summary: "POST: /Bundle/{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": "Bundle",
"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"
/Bundle/{id}/$meta-delete:
post:
tags:
- Bundle
summary: "POST: /Bundle/{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"
/Bundle/{id}/$meta-add:
post:
tags:
- Bundle
summary: "POST: /Bundle/{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"
/Bundle/$meta:
get:
tags:
- Bundle
summary: "GET: /Bundle/$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:
- Bundle
summary: "POST: /Bundle/$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"
/Bundle/{id}/$meta:
get:
tags:
- Bundle
summary: "GET: /Bundle/{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:
- Bundle
summary: "POST: /Bundle/{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"
/Bundle/$expunge:
post:
tags:
- Bundle
summary: "POST: /Bundle/$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"
/Bundle/{id}/$expunge:
post:
tags:
- Bundle
summary: "POST: /Bundle/{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"
/Bundle/{id}/$diff:
get:
tags:
- Bundle
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:
- Bundle
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"
/CapabilityStatement/{id}:
get:
tags:
- CapabilityStatement
summary: "read-instance: Read CapabilityStatement instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- CapabilityStatement
summary: "update-instance: Update an existing CapabilityStatement 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": "CapabilityStatement"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- CapabilityStatement
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:
- CapabilityStatement
summary: "instance-patch: Patch a resource instance of type CapabilityStatement\
\ 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"
/CapabilityStatement/{id}/_history/{version_id}:
get:
tags:
- CapabilityStatement
summary: "vread-instance: Read CapabilityStatement instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CapabilityStatement:
get:
tags:
- CapabilityStatement
summary: "search-type: Search for CapabilityStatement instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: software
in: query
description: Part of the name of a software application
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: fhirversion
in: query
description: The version of FHIR
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: mode
in: query
description: Mode - restful (server/client) or messaging (sender/receiver)
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: guide
in: query
description: Implementation guides supported
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: resource-profile
in: query
description: A profile id invoked in a capability statement
required: false
schema:
type: string
- name: resource
in: query
description: Name of a resource mentioned in a capability statement
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: format
in: query
description: formats supported (xml | json | ttl | mime type)
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: supported-profile
in: query
description: Profiles for use cases supported
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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: security-service
in: query
description: OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- CapabilityStatement
summary: "create-type: Create a new CapabilityStatement instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "CapabilityStatement"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CapabilityStatement/_history:
get:
tags:
- CapabilityStatement
summary: "type-history: Fetch the resource change history for all resources\
\ of type CapabilityStatement"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CapabilityStatement/{id}/_history:
get:
tags:
- CapabilityStatement
summary: "instance-history: Fetch the resource change history for all resources\
\ of type CapabilityStatement"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CapabilityStatement/_search:
get:
tags:
- CapabilityStatement
summary: "search-type: Search for CapabilityStatement instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: software
in: query
description: Part of the name of a software application
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: fhirversion
in: query
description: The version of FHIR
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: mode
in: query
description: Mode - restful (server/client) or messaging (sender/receiver)
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: guide
in: query
description: Implementation guides supported
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: resource-profile
in: query
description: A profile id invoked in a capability statement
required: false
schema:
type: string
- name: resource
in: query
description: Name of a resource mentioned in a capability statement
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: format
in: query
description: formats supported (xml | json | ttl | mime type)
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: supported-profile
in: query
description: Profiles for use cases supported
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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: security-service
in: query
description: OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CapabilityStatement/$validate:
get:
tags:
- CapabilityStatement
summary: "GET: /CapabilityStatement/$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:
- CapabilityStatement
summary: "POST: /CapabilityStatement/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "CapabilityStatement",
"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"
/CapabilityStatement/{id}/$validate:
get:
tags:
- CapabilityStatement
summary: "GET: /CapabilityStatement/{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:
- CapabilityStatement
summary: "POST: /CapabilityStatement/{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": "CapabilityStatement",
"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"
/CapabilityStatement/{id}/$meta-delete:
post:
tags:
- CapabilityStatement
summary: "POST: /CapabilityStatement/{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"
/CapabilityStatement/{id}/$meta-add:
post:
tags:
- CapabilityStatement
summary: "POST: /CapabilityStatement/{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"
/CapabilityStatement/$meta:
get:
tags:
- CapabilityStatement
summary: "GET: /CapabilityStatement/$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:
- CapabilityStatement
summary: "POST: /CapabilityStatement/$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"
/CapabilityStatement/{id}/$meta:
get:
tags:
- CapabilityStatement
summary: "GET: /CapabilityStatement/{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:
- CapabilityStatement
summary: "POST: /CapabilityStatement/{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"
/CapabilityStatement/$expunge:
post:
tags:
- CapabilityStatement
summary: "POST: /CapabilityStatement/$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"
/CapabilityStatement/{id}/$expunge:
post:
tags:
- CapabilityStatement
summary: "POST: /CapabilityStatement/{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"
/CapabilityStatement/{id}/$diff:
get:
tags:
- CapabilityStatement
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:
- CapabilityStatement
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"
/CarePlan/{id}:
get:
tags:
- CarePlan
summary: "read-instance: Read CarePlan instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- CarePlan
summary: "update-instance: Update an existing CarePlan 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": "CarePlan"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- CarePlan
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:
- CarePlan
summary: "instance-patch: Patch a resource instance of type CarePlan 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"
/CarePlan/{id}/_history/{version_id}:
get:
tags:
- CarePlan
summary: "vread-instance: Read CarePlan instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CarePlan:
get:
tags:
- CarePlan
summary: "search-type: Search for CarePlan instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: care-team
in: query
description: Who's involved in plan?
required: false
schema:
type: string
- name: subject
in: query
description: Who the care plan is for
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: part-of
in: query
description: Part of referenced CarePlan
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: Fulfills CarePlan
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: activity-date
in: query
description: "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
required: false
schema:
type: string
- name: activity-code
in: query
description: Detail type of activity
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: goal
in: query
description: Desired outcome of plan
required: false
schema:
type: string
- name: performer
in: query
description: "Matches if the practitioner is listed as a performer in any\
\ of the \"simple\" activities. (For performers of the detailed activities,\
\ chain through the activitydetail search parameter.)"
required: false
schema:
type: string
- name: replaces
in: query
description: CarePlan replaced by this CarePlan
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
required: false
schema:
type: string
- name: encounter
in: query
description: Encounter created as part of
required: false
schema:
type: string
- name: intent
in: query
description: proposal | plan | order | option
required: false
schema:
type: string
- name: activity-reference
in: query
description: Activity details defined in specific 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: condition
in: query
description: Health issues this plan addresses
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: Type of plan
required: false
schema:
type: string
- name: status
in: query
description: draft | active | on-hold | revoked | completed | entered-in-error
| unknown
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:
- CarePlan
summary: "create-type: Create a new CarePlan instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "CarePlan"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CarePlan/_history:
get:
tags:
- CarePlan
summary: "type-history: Fetch the resource change history for all resources\
\ of type CarePlan"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CarePlan/{id}/_history:
get:
tags:
- CarePlan
summary: "instance-history: Fetch the resource change history for all resources\
\ of type CarePlan"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CarePlan/_search:
get:
tags:
- CarePlan
summary: "search-type: Search for CarePlan instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: care-team
in: query
description: Who's involved in plan?
required: false
schema:
type: string
- name: subject
in: query
description: Who the care plan is for
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: part-of
in: query
description: Part of referenced CarePlan
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: Fulfills CarePlan
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: activity-date
in: query
description: "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
required: false
schema:
type: string
- name: activity-code
in: query
description: Detail type of activity
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: goal
in: query
description: Desired outcome of plan
required: false
schema:
type: string
- name: performer
in: query
description: "Matches if the practitioner is listed as a performer in any\
\ of the \"simple\" activities. (For performers of the detailed activities,\
\ chain through the activitydetail search parameter.)"
required: false
schema:
type: string
- name: replaces
in: query
description: CarePlan replaced by this CarePlan
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
required: false
schema:
type: string
- name: encounter
in: query
description: Encounter created as part of
required: false
schema:
type: string
- name: intent
in: query
description: proposal | plan | order | option
required: false
schema:
type: string
- name: activity-reference
in: query
description: Activity details defined in specific 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: condition
in: query
description: Health issues this plan addresses
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: Type of plan
required: false
schema:
type: string
- name: status
in: query
description: draft | active | on-hold | revoked | completed | entered-in-error
| unknown
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"
/CarePlan/$validate:
get:
tags:
- CarePlan
summary: "GET: /CarePlan/$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:
- CarePlan
summary: "POST: /CarePlan/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "CarePlan",
"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"
/CarePlan/{id}/$validate:
get:
tags:
- CarePlan
summary: "GET: /CarePlan/{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:
- CarePlan
summary: "POST: /CarePlan/{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": "CarePlan",
"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"
/CarePlan/{id}/$meta-delete:
post:
tags:
- CarePlan
summary: "POST: /CarePlan/{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"
/CarePlan/{id}/$meta-add:
post:
tags:
- CarePlan
summary: "POST: /CarePlan/{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"
/CarePlan/$meta:
get:
tags:
- CarePlan
summary: "GET: /CarePlan/$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:
- CarePlan
summary: "POST: /CarePlan/$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"
/CarePlan/{id}/$meta:
get:
tags:
- CarePlan
summary: "GET: /CarePlan/{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:
- CarePlan
summary: "POST: /CarePlan/{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"
/CarePlan/$expunge:
post:
tags:
- CarePlan
summary: "POST: /CarePlan/$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"
/CarePlan/{id}/$expunge:
post:
tags:
- CarePlan
summary: "POST: /CarePlan/{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"
/CarePlan/{id}/$diff:
get:
tags:
- CarePlan
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:
- CarePlan
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"
/CareTeam/{id}:
get:
tags:
- CareTeam
summary: "read-instance: Read CareTeam instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- CareTeam
summary: "update-instance: Update an existing CareTeam 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": "CareTeam"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- CareTeam
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:
- CareTeam
summary: "instance-patch: Patch a resource instance of type CareTeam 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"
/CareTeam/{id}/_history/{version_id}:
get:
tags:
- CareTeam
summary: "vread-instance: Read CareTeam instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CareTeam:
get:
tags:
- CareTeam
summary: "search-type: Search for CareTeam instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: subject
in: query
description: Who care team is for
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: Encounter created as part of
required: false
schema:
type: string
- name: participant
in: query
description: Who is involved
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: Type of team
required: false
schema:
type: string
- name: status
in: query
description: proposed | active | suspended | inactive | entered-in-error
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:
- CareTeam
summary: "create-type: Create a new CareTeam instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "CareTeam"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CareTeam/_history:
get:
tags:
- CareTeam
summary: "type-history: Fetch the resource change history for all resources\
\ of type CareTeam"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CareTeam/{id}/_history:
get:
tags:
- CareTeam
summary: "instance-history: Fetch the resource change history for all resources\
\ of type CareTeam"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CareTeam/_search:
get:
tags:
- CareTeam
summary: "search-type: Search for CareTeam instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: subject
in: query
description: Who care team is for
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: Encounter created as part of
required: false
schema:
type: string
- name: participant
in: query
description: Who is involved
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: Type of team
required: false
schema:
type: string
- name: status
in: query
description: proposed | active | suspended | inactive | entered-in-error
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"
/CareTeam/$validate:
get:
tags:
- CareTeam
summary: "GET: /CareTeam/$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:
- CareTeam
summary: "POST: /CareTeam/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "CareTeam",
"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"
/CareTeam/{id}/$validate:
get:
tags:
- CareTeam
summary: "GET: /CareTeam/{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:
- CareTeam
summary: "POST: /CareTeam/{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": "CareTeam",
"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"
/CareTeam/{id}/$meta-delete:
post:
tags:
- CareTeam
summary: "POST: /CareTeam/{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"
/CareTeam/{id}/$meta-add:
post:
tags:
- CareTeam
summary: "POST: /CareTeam/{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"
/CareTeam/$meta:
get:
tags:
- CareTeam
summary: "GET: /CareTeam/$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:
- CareTeam
summary: "POST: /CareTeam/$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"
/CareTeam/{id}/$meta:
get:
tags:
- CareTeam
summary: "GET: /CareTeam/{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:
- CareTeam
summary: "POST: /CareTeam/{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"
/CareTeam/$expunge:
post:
tags:
- CareTeam
summary: "POST: /CareTeam/$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"
/CareTeam/{id}/$expunge:
post:
tags:
- CareTeam
summary: "POST: /CareTeam/{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"
/CareTeam/{id}/$diff:
get:
tags:
- CareTeam
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:
- CareTeam
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"
/CatalogEntry/{id}:
get:
tags:
- CatalogEntry
summary: "read-instance: Read CatalogEntry instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- CatalogEntry
summary: "update-instance: Update an existing CatalogEntry 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": "CatalogEntry"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- CatalogEntry
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:
- CatalogEntry
summary: "instance-patch: Patch a resource instance of type CatalogEntry 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"
/CatalogEntry/{id}/_history/{version_id}:
get:
tags:
- CatalogEntry
summary: "vread-instance: Read CatalogEntry instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CatalogEntry:
get:
tags:
- CatalogEntry
summary: "search-type: Search for CatalogEntry instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- CatalogEntry
summary: "create-type: Create a new CatalogEntry instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "CatalogEntry"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CatalogEntry/_history:
get:
tags:
- CatalogEntry
summary: "type-history: Fetch the resource change history for all resources\
\ of type CatalogEntry"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CatalogEntry/{id}/_history:
get:
tags:
- CatalogEntry
summary: "instance-history: Fetch the resource change history for all resources\
\ of type CatalogEntry"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CatalogEntry/_search:
get:
tags:
- CatalogEntry
summary: "search-type: Search for CatalogEntry instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/CatalogEntry/$validate:
get:
tags:
- CatalogEntry
summary: "GET: /CatalogEntry/$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:
- CatalogEntry
summary: "POST: /CatalogEntry/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "CatalogEntry",
"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"
/CatalogEntry/{id}/$validate:
get:
tags:
- CatalogEntry
summary: "GET: /CatalogEntry/{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:
- CatalogEntry
summary: "POST: /CatalogEntry/{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": "CatalogEntry",
"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"
/CatalogEntry/{id}/$meta-delete:
post:
tags:
- CatalogEntry
summary: "POST: /CatalogEntry/{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"
/CatalogEntry/{id}/$meta-add:
post:
tags:
- CatalogEntry
summary: "POST: /CatalogEntry/{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"
/CatalogEntry/$meta:
get:
tags:
- CatalogEntry
summary: "GET: /CatalogEntry/$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:
- CatalogEntry
summary: "POST: /CatalogEntry/$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"
/CatalogEntry/{id}/$meta:
get:
tags:
- CatalogEntry
summary: "GET: /CatalogEntry/{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:
- CatalogEntry
summary: "POST: /CatalogEntry/{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"
/CatalogEntry/$expunge:
post:
tags:
- CatalogEntry
summary: "POST: /CatalogEntry/$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"
/CatalogEntry/{id}/$expunge:
post:
tags:
- CatalogEntry
summary: "POST: /CatalogEntry/{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"
/CatalogEntry/{id}/$diff:
get:
tags:
- CatalogEntry
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:
- CatalogEntry
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"
/ChargeItem/{id}:
get:
tags:
- ChargeItem
summary: "read-instance: Read ChargeItem instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ChargeItem
summary: "update-instance: Update an existing ChargeItem 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": "ChargeItem"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- ChargeItem
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:
- ChargeItem
summary: "instance-patch: Patch a resource instance of type ChargeItem 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"
/ChargeItem/{id}/_history/{version_id}:
get:
tags:
- ChargeItem
summary: "vread-instance: Read ChargeItem instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ChargeItem:
get:
tags:
- ChargeItem
summary: "search-type: Search for ChargeItem instances"
description: This is a search type
parameters:
- name: performing-organization
in: query
description: Organization providing the charged service
required: false
schema:
type: string
- name: code
in: query
description: "A code that identifies the charge, like a billing code"
required: false
schema:
type: string
- name: subject
in: query
description: Individual service was done for/to
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: occurrence
in: query
description: When the charged service was applied
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: entered-date
in: query
description: Date the charge item was entered
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: performer-function
in: query
description: What type of performance was done
required: false
schema:
type: string
- name: factor-override
in: query
description: Factor overriding the associated rules
required: false
schema:
type: number
- name: patient
in: query
description: Individual service was done for/to
required: false
schema:
type: string
- name: price-override
in: query
description: Price overriding the associated rules
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: Encounter / Episode associated with event
required: false
schema:
type: string
- name: enterer
in: query
description: Individual who was entering
required: false
schema:
type: string
- name: identifier
in: query
description: Business Identifier for item
required: false
schema:
type: string
- name: quantity
in: query
description: Quantity of which the charge item has been serviced
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: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: service
in: query
description: Which rendered service is being charged?
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: performer-actor
in: query
description: Individual who was performing
required: false
schema:
type: string
- name: account
in: query
description: Account to place this charge
required: false
schema:
type: string
- name: requesting-organization
in: query
description: Organization requesting the charged service
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:
- ChargeItem
summary: "create-type: Create a new ChargeItem instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ChargeItem"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ChargeItem/_history:
get:
tags:
- ChargeItem
summary: "type-history: Fetch the resource change history for all resources\
\ of type ChargeItem"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ChargeItem/{id}/_history:
get:
tags:
- ChargeItem
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ChargeItem"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ChargeItem/_search:
get:
tags:
- ChargeItem
summary: "search-type: Search for ChargeItem instances"
description: This is a search type
parameters:
- name: performing-organization
in: query
description: Organization providing the charged service
required: false
schema:
type: string
- name: code
in: query
description: "A code that identifies the charge, like a billing code"
required: false
schema:
type: string
- name: subject
in: query
description: Individual service was done for/to
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: occurrence
in: query
description: When the charged service was applied
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: entered-date
in: query
description: Date the charge item was entered
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: performer-function
in: query
description: What type of performance was done
required: false
schema:
type: string
- name: factor-override
in: query
description: Factor overriding the associated rules
required: false
schema:
type: number
- name: patient
in: query
description: Individual service was done for/to
required: false
schema:
type: string
- name: price-override
in: query
description: Price overriding the associated rules
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: Encounter / Episode associated with event
required: false
schema:
type: string
- name: enterer
in: query
description: Individual who was entering
required: false
schema:
type: string
- name: identifier
in: query
description: Business Identifier for item
required: false
schema:
type: string
- name: quantity
in: query
description: Quantity of which the charge item has been serviced
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: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: service
in: query
description: Which rendered service is being charged?
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: performer-actor
in: query
description: Individual who was performing
required: false
schema:
type: string
- name: account
in: query
description: Account to place this charge
required: false
schema:
type: string
- name: requesting-organization
in: query
description: Organization requesting the charged service
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"
/ChargeItem/$validate:
get:
tags:
- ChargeItem
summary: "GET: /ChargeItem/$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:
- ChargeItem
summary: "POST: /ChargeItem/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ChargeItem",
"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"
/ChargeItem/{id}/$validate:
get:
tags:
- ChargeItem
summary: "GET: /ChargeItem/{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:
- ChargeItem
summary: "POST: /ChargeItem/{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": "ChargeItem",
"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"
/ChargeItem/{id}/$meta-delete:
post:
tags:
- ChargeItem
summary: "POST: /ChargeItem/{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"
/ChargeItem/{id}/$meta-add:
post:
tags:
- ChargeItem
summary: "POST: /ChargeItem/{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"
/ChargeItem/$meta:
get:
tags:
- ChargeItem
summary: "GET: /ChargeItem/$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:
- ChargeItem
summary: "POST: /ChargeItem/$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"
/ChargeItem/{id}/$meta:
get:
tags:
- ChargeItem
summary: "GET: /ChargeItem/{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:
- ChargeItem
summary: "POST: /ChargeItem/{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"
/ChargeItem/$expunge:
post:
tags:
- ChargeItem
summary: "POST: /ChargeItem/$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"
/ChargeItem/{id}/$expunge:
post:
tags:
- ChargeItem
summary: "POST: /ChargeItem/{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"
/ChargeItem/{id}/$diff:
get:
tags:
- ChargeItem
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:
- ChargeItem
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"
/ChargeItemDefinition/{id}:
get:
tags:
- ChargeItemDefinition
summary: "read-instance: Read ChargeItemDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ChargeItemDefinition
summary: "update-instance: Update an existing ChargeItemDefinition 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": "ChargeItemDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- ChargeItemDefinition
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:
- ChargeItemDefinition
summary: "instance-patch: Patch a resource instance of type ChargeItemDefinition\
\ 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"
/ChargeItemDefinition/{id}/_history/{version_id}:
get:
tags:
- ChargeItemDefinition
summary: "vread-instance: Read ChargeItemDefinition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ChargeItemDefinition:
get:
tags:
- ChargeItemDefinition
summary: "search-type: Search for ChargeItemDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The charge item definition publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: External identifier for the charge item definition
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the charge item definition
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the charge item definition
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: description
in: query
description: The description of the charge item definition
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the charge item definition
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the charge item definition
required: false
schema:
type: string
- name: version
in: query
description: The business version of the charge item definition
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the charge item definition
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: A quantity- or range-valued use context assigned to the charge
item definition
required: false
schema:
anyOf:
- type: string
- type: number
- name: effective
in: query
description: The time during which the charge item definition is intended
to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: A use context assigned to the charge item definition
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the charge item definition
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: A use context type and quantity- or range-based value assigned
to the charge item definition
required: false
schema:
type: string
- name: status
in: query
description: The current status of the charge item definition
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:
- ChargeItemDefinition
summary: "create-type: Create a new ChargeItemDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ChargeItemDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ChargeItemDefinition/_history:
get:
tags:
- ChargeItemDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type ChargeItemDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ChargeItemDefinition/{id}/_history:
get:
tags:
- ChargeItemDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ChargeItemDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ChargeItemDefinition/_search:
get:
tags:
- ChargeItemDefinition
summary: "search-type: Search for ChargeItemDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The charge item definition publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: External identifier for the charge item definition
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the charge item definition
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the charge item definition
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: description
in: query
description: The description of the charge item definition
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the charge item definition
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the charge item definition
required: false
schema:
type: string
- name: version
in: query
description: The business version of the charge item definition
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the charge item definition
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: A quantity- or range-valued use context assigned to the charge
item definition
required: false
schema:
anyOf:
- type: string
- type: number
- name: effective
in: query
description: The time during which the charge item definition is intended
to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: A use context assigned to the charge item definition
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the charge item definition
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: A use context type and quantity- or range-based value assigned
to the charge item definition
required: false
schema:
type: string
- name: status
in: query
description: The current status of the charge item definition
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"
/ChargeItemDefinition/$validate:
get:
tags:
- ChargeItemDefinition
summary: "GET: /ChargeItemDefinition/$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:
- ChargeItemDefinition
summary: "POST: /ChargeItemDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ChargeItemDefinition",
"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"
/ChargeItemDefinition/{id}/$validate:
get:
tags:
- ChargeItemDefinition
summary: "GET: /ChargeItemDefinition/{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:
- ChargeItemDefinition
summary: "POST: /ChargeItemDefinition/{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": "ChargeItemDefinition",
"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"
/ChargeItemDefinition/{id}/$meta-delete:
post:
tags:
- ChargeItemDefinition
summary: "POST: /ChargeItemDefinition/{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"
/ChargeItemDefinition/{id}/$meta-add:
post:
tags:
- ChargeItemDefinition
summary: "POST: /ChargeItemDefinition/{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"
/ChargeItemDefinition/$meta:
get:
tags:
- ChargeItemDefinition
summary: "GET: /ChargeItemDefinition/$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:
- ChargeItemDefinition
summary: "POST: /ChargeItemDefinition/$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"
/ChargeItemDefinition/{id}/$meta:
get:
tags:
- ChargeItemDefinition
summary: "GET: /ChargeItemDefinition/{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:
- ChargeItemDefinition
summary: "POST: /ChargeItemDefinition/{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"
/ChargeItemDefinition/$expunge:
post:
tags:
- ChargeItemDefinition
summary: "POST: /ChargeItemDefinition/$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"
/ChargeItemDefinition/{id}/$expunge:
post:
tags:
- ChargeItemDefinition
summary: "POST: /ChargeItemDefinition/{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"
/ChargeItemDefinition/{id}/$diff:
get:
tags:
- ChargeItemDefinition
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:
- ChargeItemDefinition
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"
/Claim/{id}:
get:
tags:
- Claim
summary: "read-instance: Read Claim instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Claim
summary: "update-instance: Update an existing Claim 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": "Claim"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Claim
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:
- Claim
summary: "instance-patch: Patch a resource instance of type Claim 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"
/Claim/{id}/_history/{version_id}:
get:
tags:
- Claim
summary: "vread-instance: Read Claim instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Claim:
get:
tags:
- Claim
summary: "search-type: Search for Claim instances"
description: This is a search type
parameters:
- name: care-team
in: query
description: Member of the CareTeam
required: false
schema:
type: string
- name: use
in: query
description: The kind of financial resource
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: payee
in: query
description: The party receiving any payment for the Claim
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: provider
in: query
description: Provider responsible for the Claim
required: false
schema:
type: string
- name: insurer
in: query
description: The target payor/insurer for the Claim
required: false
schema:
type: string
- name: patient
in: query
description: Patient receiving the products or services
required: false
schema:
type: string
- name: detail-udi
in: query
description: "UDI associated with a line item, detail product or service"
required: false
schema:
type: string
- name: enterer
in: query
description: The party responsible for the entry of the Claim
required: false
schema:
type: string
- name: procedure-udi
in: query
description: UDI associated with a procedure
required: false
schema:
type: string
- name: item-udi
in: query
description: UDI associated with a line item product or service
required: false
schema:
type: string
- name: identifier
in: query
description: The primary identifier of the financial resource
required: false
schema:
type: string
- name: created
in: query
description: The creation date for the Claim
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: Encounters associated with a billed line item
required: false
schema:
type: string
- name: priority
in: query
description: Processing priority requested
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: subdetail-udi
in: query
description: "UDI associated with a line item, detail, subdetail product or\
\ service"
required: false
schema:
type: string
- name: facility
in: query
description: Facility where the products or services have been or will be
provided
required: false
schema:
type: string
- name: status
in: query
description: The status of the Claim instance.
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:
- Claim
summary: "create-type: Create a new Claim instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Claim"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Claim/_history:
get:
tags:
- Claim
summary: "type-history: Fetch the resource change history for all resources\
\ of type Claim"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Claim/{id}/_history:
get:
tags:
- Claim
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Claim"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Claim/_search:
get:
tags:
- Claim
summary: "search-type: Search for Claim instances"
description: This is a search type
parameters:
- name: care-team
in: query
description: Member of the CareTeam
required: false
schema:
type: string
- name: use
in: query
description: The kind of financial resource
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: payee
in: query
description: The party receiving any payment for the Claim
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: provider
in: query
description: Provider responsible for the Claim
required: false
schema:
type: string
- name: insurer
in: query
description: The target payor/insurer for the Claim
required: false
schema:
type: string
- name: patient
in: query
description: Patient receiving the products or services
required: false
schema:
type: string
- name: detail-udi
in: query
description: "UDI associated with a line item, detail product or service"
required: false
schema:
type: string
- name: enterer
in: query
description: The party responsible for the entry of the Claim
required: false
schema:
type: string
- name: procedure-udi
in: query
description: UDI associated with a procedure
required: false
schema:
type: string
- name: item-udi
in: query
description: UDI associated with a line item product or service
required: false
schema:
type: string
- name: identifier
in: query
description: The primary identifier of the financial resource
required: false
schema:
type: string
- name: created
in: query
description: The creation date for the Claim
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: Encounters associated with a billed line item
required: false
schema:
type: string
- name: priority
in: query
description: Processing priority requested
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: subdetail-udi
in: query
description: "UDI associated with a line item, detail, subdetail product or\
\ service"
required: false
schema:
type: string
- name: facility
in: query
description: Facility where the products or services have been or will be
provided
required: false
schema:
type: string
- name: status
in: query
description: The status of the Claim instance.
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"
/Claim/$validate:
get:
tags:
- Claim
summary: "GET: /Claim/$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:
- Claim
summary: "POST: /Claim/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Claim",
"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"
/Claim/{id}/$validate:
get:
tags:
- Claim
summary: "GET: /Claim/{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:
- Claim
summary: "POST: /Claim/{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": "Claim",
"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"
/Claim/{id}/$meta-delete:
post:
tags:
- Claim
summary: "POST: /Claim/{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"
/Claim/{id}/$meta-add:
post:
tags:
- Claim
summary: "POST: /Claim/{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"
/Claim/$meta:
get:
tags:
- Claim
summary: "GET: /Claim/$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:
- Claim
summary: "POST: /Claim/$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"
/Claim/{id}/$meta:
get:
tags:
- Claim
summary: "GET: /Claim/{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:
- Claim
summary: "POST: /Claim/{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"
/Claim/$expunge:
post:
tags:
- Claim
summary: "POST: /Claim/$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"
/Claim/{id}/$expunge:
post:
tags:
- Claim
summary: "POST: /Claim/{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"
/Claim/{id}/$diff:
get:
tags:
- Claim
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:
- Claim
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"
/ClaimResponse/{id}:
get:
tags:
- ClaimResponse
summary: "read-instance: Read ClaimResponse instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ClaimResponse
summary: "update-instance: Update an existing ClaimResponse 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": "ClaimResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- ClaimResponse
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:
- ClaimResponse
summary: "instance-patch: Patch a resource instance of type ClaimResponse 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"
/ClaimResponse/{id}/_history/{version_id}:
get:
tags:
- ClaimResponse
summary: "vread-instance: Read ClaimResponse instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ClaimResponse:
get:
tags:
- ClaimResponse
summary: "search-type: Search for ClaimResponse instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The identity of the ClaimResponse
required: false
schema:
type: string
- name: request
in: query
description: The claim reference
required: false
schema:
type: string
- name: created
in: query
description: The creation date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: use
in: query
description: The type of 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: payment-date
in: query
description: The expected payment date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: requestor
in: query
description: The Provider of the claim
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: disposition
in: query
description: The contents of the disposition message
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: insurer
in: query
description: The organization which generated this resource
required: false
schema:
type: string
- name: patient
in: query
description: The subject of care
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: outcome
in: query
description: The processing outcome
required: false
schema:
type: string
- name: status
in: query
description: The status of the ClaimResponse
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:
- ClaimResponse
summary: "create-type: Create a new ClaimResponse instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ClaimResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ClaimResponse/_history:
get:
tags:
- ClaimResponse
summary: "type-history: Fetch the resource change history for all resources\
\ of type ClaimResponse"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ClaimResponse/{id}/_history:
get:
tags:
- ClaimResponse
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ClaimResponse"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ClaimResponse/_search:
get:
tags:
- ClaimResponse
summary: "search-type: Search for ClaimResponse instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The identity of the ClaimResponse
required: false
schema:
type: string
- name: request
in: query
description: The claim reference
required: false
schema:
type: string
- name: created
in: query
description: The creation date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: use
in: query
description: The type of 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: payment-date
in: query
description: The expected payment date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: requestor
in: query
description: The Provider of the claim
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: disposition
in: query
description: The contents of the disposition message
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: insurer
in: query
description: The organization which generated this resource
required: false
schema:
type: string
- name: patient
in: query
description: The subject of care
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: outcome
in: query
description: The processing outcome
required: false
schema:
type: string
- name: status
in: query
description: The status of the ClaimResponse
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"
/ClaimResponse/$validate:
get:
tags:
- ClaimResponse
summary: "GET: /ClaimResponse/$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:
- ClaimResponse
summary: "POST: /ClaimResponse/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ClaimResponse",
"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"
/ClaimResponse/{id}/$validate:
get:
tags:
- ClaimResponse
summary: "GET: /ClaimResponse/{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:
- ClaimResponse
summary: "POST: /ClaimResponse/{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": "ClaimResponse",
"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"
/ClaimResponse/{id}/$meta-delete:
post:
tags:
- ClaimResponse
summary: "POST: /ClaimResponse/{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"
/ClaimResponse/{id}/$meta-add:
post:
tags:
- ClaimResponse
summary: "POST: /ClaimResponse/{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"
/ClaimResponse/$meta:
get:
tags:
- ClaimResponse
summary: "GET: /ClaimResponse/$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:
- ClaimResponse
summary: "POST: /ClaimResponse/$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"
/ClaimResponse/{id}/$meta:
get:
tags:
- ClaimResponse
summary: "GET: /ClaimResponse/{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:
- ClaimResponse
summary: "POST: /ClaimResponse/{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"
/ClaimResponse/$expunge:
post:
tags:
- ClaimResponse
summary: "POST: /ClaimResponse/$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"
/ClaimResponse/{id}/$expunge:
post:
tags:
- ClaimResponse
summary: "POST: /ClaimResponse/{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"
/ClaimResponse/{id}/$diff:
get:
tags:
- ClaimResponse
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:
- ClaimResponse
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"
/ClinicalImpression/{id}:
get:
tags:
- ClinicalImpression
summary: "read-instance: Read ClinicalImpression instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ClinicalImpression
summary: "update-instance: Update an existing ClinicalImpression 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": "ClinicalImpression"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- ClinicalImpression
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:
- ClinicalImpression
summary: "instance-patch: Patch a resource instance of type ClinicalImpression\
\ 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"
/ClinicalImpression/{id}/_history/{version_id}:
get:
tags:
- ClinicalImpression
summary: "vread-instance: Read ClinicalImpression instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ClinicalImpression:
get:
tags:
- ClinicalImpression
summary: "search-type: Search for ClinicalImpression instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: Business identifier
required: false
schema:
type: string
- name: previous
in: query
description: Reference to last assessment
required: false
schema:
type: string
- name: finding-code
in: query
description: What was found
required: false
schema:
type: string
- name: assessor
in: query
description: The clinician performing the assessment
required: false
schema:
type: string
- name: subject
in: query
description: Patient or group assessed
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: Encounter created as part of
required: false
schema:
type: string
- name: finding-ref
in: query
description: What was found
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: problem
in: query
description: Relevant impressions of patient state
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: supporting-info
in: query
description: Information supporting the clinical impression
required: false
schema:
type: string
- name: investigation
in: query
description: Record of a specific investigation
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: in-progress | completed | entered-in-error
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:
- ClinicalImpression
summary: "create-type: Create a new ClinicalImpression instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ClinicalImpression"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ClinicalImpression/_history:
get:
tags:
- ClinicalImpression
summary: "type-history: Fetch the resource change history for all resources\
\ of type ClinicalImpression"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ClinicalImpression/{id}/_history:
get:
tags:
- ClinicalImpression
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ClinicalImpression"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ClinicalImpression/_search:
get:
tags:
- ClinicalImpression
summary: "search-type: Search for ClinicalImpression instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: Business identifier
required: false
schema:
type: string
- name: previous
in: query
description: Reference to last assessment
required: false
schema:
type: string
- name: finding-code
in: query
description: What was found
required: false
schema:
type: string
- name: assessor
in: query
description: The clinician performing the assessment
required: false
schema:
type: string
- name: subject
in: query
description: Patient or group assessed
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: Encounter created as part of
required: false
schema:
type: string
- name: finding-ref
in: query
description: What was found
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: problem
in: query
description: Relevant impressions of patient state
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: supporting-info
in: query
description: Information supporting the clinical impression
required: false
schema:
type: string
- name: investigation
in: query
description: Record of a specific investigation
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: in-progress | completed | entered-in-error
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"
/ClinicalImpression/$validate:
get:
tags:
- ClinicalImpression
summary: "GET: /ClinicalImpression/$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:
- ClinicalImpression
summary: "POST: /ClinicalImpression/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ClinicalImpression",
"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"
/ClinicalImpression/{id}/$validate:
get:
tags:
- ClinicalImpression
summary: "GET: /ClinicalImpression/{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:
- ClinicalImpression
summary: "POST: /ClinicalImpression/{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": "ClinicalImpression",
"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"
/ClinicalImpression/{id}/$meta-delete:
post:
tags:
- ClinicalImpression
summary: "POST: /ClinicalImpression/{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"
/ClinicalImpression/{id}/$meta-add:
post:
tags:
- ClinicalImpression
summary: "POST: /ClinicalImpression/{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"
/ClinicalImpression/$meta:
get:
tags:
- ClinicalImpression
summary: "GET: /ClinicalImpression/$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:
- ClinicalImpression
summary: "POST: /ClinicalImpression/$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"
/ClinicalImpression/{id}/$meta:
get:
tags:
- ClinicalImpression
summary: "GET: /ClinicalImpression/{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:
- ClinicalImpression
summary: "POST: /ClinicalImpression/{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"
/ClinicalImpression/$expunge:
post:
tags:
- ClinicalImpression
summary: "POST: /ClinicalImpression/$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"
/ClinicalImpression/{id}/$expunge:
post:
tags:
- ClinicalImpression
summary: "POST: /ClinicalImpression/{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"
/ClinicalImpression/{id}/$diff:
get:
tags:
- ClinicalImpression
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:
- ClinicalImpression
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"
/CodeSystem/{id}:
get:
tags:
- CodeSystem
summary: "read-instance: Read CodeSystem instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- CodeSystem
summary: "update-instance: Update an existing CodeSystem 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": "CodeSystem"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- CodeSystem
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:
- CodeSystem
summary: "instance-patch: Patch a resource instance of type CodeSystem 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"
/CodeSystem/{id}/_history/{version_id}:
get:
tags:
- CodeSystem
summary: "vread-instance: Read CodeSystem instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CodeSystem:
get:
tags:
- CodeSystem
summary: "search-type: Search for CodeSystem instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: A code defined in the code system
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: language
in: query
description: A language in which a designation is provided
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\
\ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\
\ External identifier for the structure map\r\n* [ValueSet](valueset.html):\
\ External identifier for the value set"
required: false
schema:
type: string
- name: content-mode
in: query
description: not-present | example | fragment | complete | supplement
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: supplements
in: query
description: Find code system supplements for the referenced code system
required: false
schema:
type: string
- name: system
in: query
description: The system for any codes defined by this code system (same as
'url')
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- CodeSystem
summary: "create-type: Create a new CodeSystem instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "CodeSystem"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CodeSystem/_history:
get:
tags:
- CodeSystem
summary: "type-history: Fetch the resource change history for all resources\
\ of type CodeSystem"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CodeSystem/{id}/_history:
get:
tags:
- CodeSystem
summary: "instance-history: Fetch the resource change history for all resources\
\ of type CodeSystem"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CodeSystem/_search:
get:
tags:
- CodeSystem
summary: "search-type: Search for CodeSystem instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: A code defined in the code system
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: language
in: query
description: A language in which a designation is provided
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\
\ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\
\ External identifier for the structure map\r\n* [ValueSet](valueset.html):\
\ External identifier for the value set"
required: false
schema:
type: string
- name: content-mode
in: query
description: not-present | example | fragment | complete | supplement
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: supplements
in: query
description: Find code system supplements for the referenced code system
required: false
schema:
type: string
- name: system
in: query
description: The system for any codes defined by this code system (same as
'url')
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CodeSystem/$upload-external-code-system:
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/$upload-external-code-system"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "system",
"valueUri": "example"
}, {
"name": "file"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CodeSystem/$apply-codesystem-delta-remove:
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/$apply-codesystem-delta-remove"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "system",
"valueUri": "example"
}, {
"name": "file"
}, {
"name": "codeSystem"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CodeSystem/$apply-codesystem-delta-add:
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/$apply-codesystem-delta-add"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "system",
"valueUri": "example"
}, {
"name": "file"
}, {
"name": "codeSystem"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CodeSystem/$validate:
get:
tags:
- CodeSystem
summary: "GET: /CodeSystem/$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:
- CodeSystem
summary: "POST: /CodeSystem/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "CodeSystem",
"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"
/CodeSystem/{id}/$validate:
get:
tags:
- CodeSystem
summary: "GET: /CodeSystem/{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:
- CodeSystem
summary: "POST: /CodeSystem/{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": "CodeSystem",
"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"
/CodeSystem/{id}/$meta-delete:
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/{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"
/CodeSystem/{id}/$meta-add:
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/{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"
/CodeSystem/$meta:
get:
tags:
- CodeSystem
summary: "GET: /CodeSystem/$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:
- CodeSystem
summary: "POST: /CodeSystem/$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"
/CodeSystem/{id}/$meta:
get:
tags:
- CodeSystem
summary: "GET: /CodeSystem/{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:
- CodeSystem
summary: "POST: /CodeSystem/{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"
/CodeSystem/$expunge:
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/$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"
/CodeSystem/{id}/$expunge:
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/{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"
/CodeSystem/$validate-code:
get:
tags:
- CodeSystem
summary: "GET: /CodeSystem/$validate-code"
parameters:
- name: url
in: query
required: false
schema:
type: string
- name: version
in: query
required: false
schema:
type: string
- name: code
in: query
required: false
schema:
type: string
- name: display
in: query
required: false
schema:
type: string
- name: coding
in: query
required: false
schema:
type: string
- name: valueSetVersion
in: query
required: false
schema:
type: string
- name: system
in: query
required: false
schema:
type: string
- name: systemVersion
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/$validate-code"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueUri": "example"
}, {
"name": "version",
"valueString": "example"
}, {
"name": "code",
"valueCode": "example"
}, {
"name": "display",
"valueString": "example"
}, {
"name": "coding",
"valueCoding": {
"system": "http://example.com",
"code": "1234"
}
}, {
"name": "codeableConcept",
"valueCodeableConcept": {
"coding": [ {
"system": "http://example.com",
"code": "1234"
} ]
}
}, {
"name": "valueSetVersion",
"valueString": "example"
}, {
"name": "system",
"valueUri": "example"
}, {
"name": "systemVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CodeSystem/{id}/$validate-code:
get:
tags:
- CodeSystem
summary: "GET: /CodeSystem/{id}/$validate-code"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: url
in: query
required: false
schema:
type: string
- name: version
in: query
required: false
schema:
type: string
- name: code
in: query
required: false
schema:
type: string
- name: display
in: query
required: false
schema:
type: string
- name: coding
in: query
required: false
schema:
type: string
- name: valueSetVersion
in: query
required: false
schema:
type: string
- name: system
in: query
required: false
schema:
type: string
- name: systemVersion
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- CodeSystem
summary: "POST: /CodeSystem/{id}/$validate-code"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueUri": "example"
}, {
"name": "version",
"valueString": "example"
}, {
"name": "code",
"valueCode": "example"
}, {
"name": "display",
"valueString": "example"
}, {
"name": "coding",
"valueCoding": {
"system": "http://example.com",
"code": "1234"
}
}, {
"name": "codeableConcept",
"valueCodeableConcept": {
"coding": [ {
"system": "http://example.com",
"code": "1234"
} ]
}
}, {
"name": "valueSetVersion",
"valueString": "example"
}, {
"name": "system",
"valueUri": "example"
}, {
"name": "systemVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CodeSystem/$subsumes:
get:
tags:
- CodeSystem
summary: "GET: /CodeSystem/$subsumes"
parameters:
- name: codeA
in: query
required: false
schema:
type: string
- name: codeB
in: query
required: false
schema:
type: string
- name: system
in: query
required: false
schema:
type: string
- name: codingA
in: query
required: false
schema:
type: string
- name: codingB
in: query
required: false
schema:
type: string
- name: version
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:
- CodeSystem
summary: "POST: /CodeSystem/$subsumes"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "codeA",
"valueCode": "example"
}, {
"name": "codeB",
"valueCode": "example"
}, {
"name": "system",
"valueUri": "example"
}, {
"name": "codingA",
"valueCoding": {
"system": "http://example.com",
"code": "1234"
}
}, {
"name": "codingB",
"valueCoding": {
"system": "http://example.com",
"code": "1234"
}
}, {
"name": "version",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CodeSystem/$lookup:
get:
tags:
- CodeSystem
summary: "GET: /CodeSystem/$lookup"
parameters:
- name: code
in: query
required: false
schema:
type: string
- name: system
in: query
required: false
schema:
type: string
- name: coding
in: query
required: false
schema:
type: string
- name: version
in: query
required: false
schema:
type: string
- name: displayLanguage
in: query
required: false
schema:
type: string
- name: property
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:
- CodeSystem
summary: "POST: /CodeSystem/$lookup"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "code",
"valueCode": "example"
}, {
"name": "system",
"valueUri": "example"
}, {
"name": "coding",
"valueCoding": {
"system": "http://example.com",
"code": "1234"
}
}, {
"name": "version",
"valueString": "example"
}, {
"name": "displayLanguage",
"valueCode": "example"
}, {
"name": "property",
"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"
/CodeSystem/{id}/$diff:
get:
tags:
- CodeSystem
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:
- CodeSystem
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"
/Communication/{id}:
get:
tags:
- Communication
summary: "read-instance: Read Communication instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Communication
summary: "update-instance: Update an existing Communication 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": "Communication"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Communication
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:
- Communication
summary: "instance-patch: Patch a resource instance of type Communication 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"
/Communication/{id}/_history/{version_id}:
get:
tags:
- Communication
summary: "vread-instance: Read Communication instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Communication:
get:
tags:
- Communication
summary: "search-type: Search for Communication instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Unique identifier
required: false
schema:
type: string
- name: subject
in: query
description: Focus of message
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: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
required: false
schema:
type: string
- name: part-of
in: query
description: Part of this action
required: false
schema:
type: string
- name: received
in: query
description: When received
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: encounter
in: query
description: Encounter created as part of
required: false
schema:
type: string
- name: medium
in: query
description: A channel of communication
required: false
schema:
type: string
- name: sent
in: query
description: When sent
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: based-on
in: query
description: Request fulfilled by this communication
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: sender
in: query
description: Message sender
required: false
schema:
type: string
- name: patient
in: query
description: Focus of message
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: recipient
in: query
description: Message recipient
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
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: Message category
required: false
schema:
type: string
- name: status
in: query
description: preparation | in-progress | not-done | on-hold | stopped | completed
| entered-in-error | unknown
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:
- Communication
summary: "create-type: Create a new Communication instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Communication"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Communication/_history:
get:
tags:
- Communication
summary: "type-history: Fetch the resource change history for all resources\
\ of type Communication"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Communication/{id}/_history:
get:
tags:
- Communication
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Communication"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Communication/_search:
get:
tags:
- Communication
summary: "search-type: Search for Communication instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Unique identifier
required: false
schema:
type: string
- name: subject
in: query
description: Focus of message
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: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
required: false
schema:
type: string
- name: part-of
in: query
description: Part of this action
required: false
schema:
type: string
- name: received
in: query
description: When received
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: encounter
in: query
description: Encounter created as part of
required: false
schema:
type: string
- name: medium
in: query
description: A channel of communication
required: false
schema:
type: string
- name: sent
in: query
description: When sent
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: based-on
in: query
description: Request fulfilled by this communication
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: sender
in: query
description: Message sender
required: false
schema:
type: string
- name: patient
in: query
description: Focus of message
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: recipient
in: query
description: Message recipient
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
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: Message category
required: false
schema:
type: string
- name: status
in: query
description: preparation | in-progress | not-done | on-hold | stopped | completed
| entered-in-error | unknown
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"
/Communication/$validate:
get:
tags:
- Communication
summary: "GET: /Communication/$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:
- Communication
summary: "POST: /Communication/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Communication",
"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"
/Communication/{id}/$validate:
get:
tags:
- Communication
summary: "GET: /Communication/{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:
- Communication
summary: "POST: /Communication/{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": "Communication",
"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"
/Communication/{id}/$meta-delete:
post:
tags:
- Communication
summary: "POST: /Communication/{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"
/Communication/{id}/$meta-add:
post:
tags:
- Communication
summary: "POST: /Communication/{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"
/Communication/$meta:
get:
tags:
- Communication
summary: "GET: /Communication/$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:
- Communication
summary: "POST: /Communication/$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"
/Communication/{id}/$meta:
get:
tags:
- Communication
summary: "GET: /Communication/{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:
- Communication
summary: "POST: /Communication/{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"
/Communication/$expunge:
post:
tags:
- Communication
summary: "POST: /Communication/$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"
/Communication/{id}/$expunge:
post:
tags:
- Communication
summary: "POST: /Communication/{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"
/Communication/{id}/$diff:
get:
tags:
- Communication
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:
- Communication
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"
/CommunicationRequest/{id}:
get:
tags:
- CommunicationRequest
summary: "read-instance: Read CommunicationRequest instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- CommunicationRequest
summary: "update-instance: Update an existing CommunicationRequest 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": "CommunicationRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- CommunicationRequest
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:
- CommunicationRequest
summary: "instance-patch: Patch a resource instance of type CommunicationRequest\
\ 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"
/CommunicationRequest/{id}/_history/{version_id}:
get:
tags:
- CommunicationRequest
summary: "vread-instance: Read CommunicationRequest instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CommunicationRequest:
get:
tags:
- CommunicationRequest
summary: "search-type: Search for CommunicationRequest instances"
description: This is a search type
parameters:
- name: authored
in: query
description: When request transitioned to being actionable
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: Focus of message
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: medium
in: query
description: A channel of communication
required: false
schema:
type: string
- name: occurrence
in: query
description: When scheduled
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: group-identifier
in: query
description: Composite request this is part of
required: false
schema:
type: string
- name: based-on
in: query
description: Fulfills plan or proposal
required: false
schema:
type: string
- name: patient
in: query
description: Focus of message
required: false
schema:
type: string
- name: requester
in: query
description: Who/what is requesting service
required: false
schema:
type: string
- name: identifier
in: query
description: Unique identifier
required: false
schema:
type: string
- name: replaces
in: query
description: Request(s) replaced by this request
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: Encounter created as part of
required: false
schema:
type: string
- name: priority
in: query
description: routine | urgent | asap | stat
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: sender
in: query
description: Message sender
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: recipient
in: query
description: Message recipient
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: Message category
required: false
schema:
type: string
- name: status
in: query
description: draft | active | on-hold | revoked | completed | entered-in-error
| unknown
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:
- CommunicationRequest
summary: "create-type: Create a new CommunicationRequest instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "CommunicationRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CommunicationRequest/_history:
get:
tags:
- CommunicationRequest
summary: "type-history: Fetch the resource change history for all resources\
\ of type CommunicationRequest"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CommunicationRequest/{id}/_history:
get:
tags:
- CommunicationRequest
summary: "instance-history: Fetch the resource change history for all resources\
\ of type CommunicationRequest"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CommunicationRequest/_search:
get:
tags:
- CommunicationRequest
summary: "search-type: Search for CommunicationRequest instances"
description: This is a search type
parameters:
- name: authored
in: query
description: When request transitioned to being actionable
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: Focus of message
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: medium
in: query
description: A channel of communication
required: false
schema:
type: string
- name: occurrence
in: query
description: When scheduled
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: group-identifier
in: query
description: Composite request this is part of
required: false
schema:
type: string
- name: based-on
in: query
description: Fulfills plan or proposal
required: false
schema:
type: string
- name: patient
in: query
description: Focus of message
required: false
schema:
type: string
- name: requester
in: query
description: Who/what is requesting service
required: false
schema:
type: string
- name: identifier
in: query
description: Unique identifier
required: false
schema:
type: string
- name: replaces
in: query
description: Request(s) replaced by this request
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: Encounter created as part of
required: false
schema:
type: string
- name: priority
in: query
description: routine | urgent | asap | stat
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: sender
in: query
description: Message sender
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: recipient
in: query
description: Message recipient
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: Message category
required: false
schema:
type: string
- name: status
in: query
description: draft | active | on-hold | revoked | completed | entered-in-error
| unknown
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"
/CommunicationRequest/$validate:
get:
tags:
- CommunicationRequest
summary: "GET: /CommunicationRequest/$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:
- CommunicationRequest
summary: "POST: /CommunicationRequest/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "CommunicationRequest",
"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"
/CommunicationRequest/{id}/$validate:
get:
tags:
- CommunicationRequest
summary: "GET: /CommunicationRequest/{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:
- CommunicationRequest
summary: "POST: /CommunicationRequest/{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": "CommunicationRequest",
"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"
/CommunicationRequest/{id}/$meta-delete:
post:
tags:
- CommunicationRequest
summary: "POST: /CommunicationRequest/{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"
/CommunicationRequest/{id}/$meta-add:
post:
tags:
- CommunicationRequest
summary: "POST: /CommunicationRequest/{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"
/CommunicationRequest/$meta:
get:
tags:
- CommunicationRequest
summary: "GET: /CommunicationRequest/$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:
- CommunicationRequest
summary: "POST: /CommunicationRequest/$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"
/CommunicationRequest/{id}/$meta:
get:
tags:
- CommunicationRequest
summary: "GET: /CommunicationRequest/{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:
- CommunicationRequest
summary: "POST: /CommunicationRequest/{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"
/CommunicationRequest/$expunge:
post:
tags:
- CommunicationRequest
summary: "POST: /CommunicationRequest/$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"
/CommunicationRequest/{id}/$expunge:
post:
tags:
- CommunicationRequest
summary: "POST: /CommunicationRequest/{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"
/CommunicationRequest/{id}/$diff:
get:
tags:
- CommunicationRequest
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:
- CommunicationRequest
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"
/CompartmentDefinition/{id}:
get:
tags:
- CompartmentDefinition
summary: "read-instance: Read CompartmentDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- CompartmentDefinition
summary: "update-instance: Update an existing CompartmentDefinition 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": "CompartmentDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- CompartmentDefinition
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:
- CompartmentDefinition
summary: "instance-patch: Patch a resource instance of type CompartmentDefinition\
\ 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"
/CompartmentDefinition/{id}/_history/{version_id}:
get:
tags:
- CompartmentDefinition
summary: "vread-instance: Read CompartmentDefinition instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CompartmentDefinition:
get:
tags:
- CompartmentDefinition
summary: "search-type: Search for CompartmentDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: Patient | Encounter | RelatedPerson | Practitioner | Device
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: resource
in: query
description: Name of resource type
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* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- CompartmentDefinition
summary: "create-type: Create a new CompartmentDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "CompartmentDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CompartmentDefinition/_history:
get:
tags:
- CompartmentDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type CompartmentDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CompartmentDefinition/{id}/_history:
get:
tags:
- CompartmentDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type CompartmentDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CompartmentDefinition/_search:
get:
tags:
- CompartmentDefinition
summary: "search-type: Search for CompartmentDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: Patient | Encounter | RelatedPerson | Practitioner | Device
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: resource
in: query
description: Name of resource type
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* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CompartmentDefinition/$validate:
get:
tags:
- CompartmentDefinition
summary: "GET: /CompartmentDefinition/$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:
- CompartmentDefinition
summary: "POST: /CompartmentDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "CompartmentDefinition",
"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"
/CompartmentDefinition/{id}/$validate:
get:
tags:
- CompartmentDefinition
summary: "GET: /CompartmentDefinition/{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:
- CompartmentDefinition
summary: "POST: /CompartmentDefinition/{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": "CompartmentDefinition",
"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"
/CompartmentDefinition/{id}/$meta-delete:
post:
tags:
- CompartmentDefinition
summary: "POST: /CompartmentDefinition/{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"
/CompartmentDefinition/{id}/$meta-add:
post:
tags:
- CompartmentDefinition
summary: "POST: /CompartmentDefinition/{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"
/CompartmentDefinition/$meta:
get:
tags:
- CompartmentDefinition
summary: "GET: /CompartmentDefinition/$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:
- CompartmentDefinition
summary: "POST: /CompartmentDefinition/$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"
/CompartmentDefinition/{id}/$meta:
get:
tags:
- CompartmentDefinition
summary: "GET: /CompartmentDefinition/{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:
- CompartmentDefinition
summary: "POST: /CompartmentDefinition/{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"
/CompartmentDefinition/$expunge:
post:
tags:
- CompartmentDefinition
summary: "POST: /CompartmentDefinition/$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"
/CompartmentDefinition/{id}/$expunge:
post:
tags:
- CompartmentDefinition
summary: "POST: /CompartmentDefinition/{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"
/CompartmentDefinition/{id}/$diff:
get:
tags:
- CompartmentDefinition
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:
- CompartmentDefinition
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"
/Composition/{id}:
get:
tags:
- Composition
summary: "read-instance: Read Composition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Composition
summary: "update-instance: Update an existing Composition 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": "Composition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Composition
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:
- Composition
summary: "instance-patch: Patch a resource instance of type Composition 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"
/Composition/{id}/_history/{version_id}:
get:
tags:
- Composition
summary: "vread-instance: Read Composition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Composition:
get:
tags:
- Composition
summary: "search-type: Search for Composition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: Who and/or what the composition is about
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: confidentiality
in: query
description: As defined by affinity domain
required: false
schema:
type: string
- name: section
in: query
description: Classification of section (recommended)
required: false
schema:
type: string
- name: type
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html):\
\ Kind of document set\r\n* [DocumentReference](documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class\
\ - e.g. specialist referral, disease management"
required: false
schema:
type: string
- name: title
in: query
description: Human Readable name/title
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: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: context
in: query
description: Code(s) that apply to the event being documented
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: period
in: query
description: The period covered by the documentation
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: related-id
in: query
description: Target of the relationship
required: false
schema:
type: string
- name: author
in: query
description: Who and/or what authored the composition
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* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: attester
in: query
description: Who attested the composition
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: entry
in: query
description: A reference to data that supports this section
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: related-ref
in: query
description: Target of the relationship
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: Categorization of Composition
required: false
schema:
type: string
- name: status
in: query
description: preliminary | final | amended | entered-in-error
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:
- Composition
summary: "create-type: Create a new Composition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Composition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Composition/_history:
get:
tags:
- Composition
summary: "type-history: Fetch the resource change history for all resources\
\ of type Composition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Composition/{id}/_history:
get:
tags:
- Composition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Composition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Composition/_search:
get:
tags:
- Composition
summary: "search-type: Search for Composition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: Who and/or what the composition is about
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: confidentiality
in: query
description: As defined by affinity domain
required: false
schema:
type: string
- name: section
in: query
description: Classification of section (recommended)
required: false
schema:
type: string
- name: type
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html):\
\ Kind of document set\r\n* [DocumentReference](documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class\
\ - e.g. specialist referral, disease management"
required: false
schema:
type: string
- name: title
in: query
description: Human Readable name/title
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: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: context
in: query
description: Code(s) that apply to the event being documented
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: period
in: query
description: The period covered by the documentation
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: related-id
in: query
description: Target of the relationship
required: false
schema:
type: string
- name: author
in: query
description: Who and/or what authored the composition
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* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: attester
in: query
description: Who attested the composition
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: entry
in: query
description: A reference to data that supports this section
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: related-ref
in: query
description: Target of the relationship
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: Categorization of Composition
required: false
schema:
type: string
- name: status
in: query
description: preliminary | final | amended | entered-in-error
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"
/Composition/$validate:
get:
tags:
- Composition
summary: "GET: /Composition/$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:
- Composition
summary: "POST: /Composition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Composition",
"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"
/Composition/{id}/$validate:
get:
tags:
- Composition
summary: "GET: /Composition/{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:
- Composition
summary: "POST: /Composition/{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": "Composition",
"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"
/Composition/{id}/$meta-delete:
post:
tags:
- Composition
summary: "POST: /Composition/{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"
/Composition/{id}/$meta-add:
post:
tags:
- Composition
summary: "POST: /Composition/{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"
/Composition/$meta:
get:
tags:
- Composition
summary: "GET: /Composition/$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:
- Composition
summary: "POST: /Composition/$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"
/Composition/{id}/$meta:
get:
tags:
- Composition
summary: "GET: /Composition/{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:
- Composition
summary: "POST: /Composition/{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"
/Composition/$expunge:
post:
tags:
- Composition
summary: "POST: /Composition/$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"
/Composition/{id}/$expunge:
post:
tags:
- Composition
summary: "POST: /Composition/{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"
/Composition/{id}/$document:
get:
tags:
- Composition
summary: "GET: /Composition/{id}/$document"
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Composition
summary: "POST: /Composition/{id}/$document"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: 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"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Composition/{id}/$diff:
get:
tags:
- Composition
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:
- Composition
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"
/ConceptMap/{id}:
get:
tags:
- ConceptMap
summary: "read-instance: Read ConceptMap instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ConceptMap
summary: "update-instance: Update an existing ConceptMap 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": "ConceptMap"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- ConceptMap
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:
- ConceptMap
summary: "instance-patch: Patch a resource instance of type ConceptMap 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"
/ConceptMap/{id}/_history/{version_id}:
get:
tags:
- ConceptMap
summary: "vread-instance: Read ConceptMap instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ConceptMap:
get:
tags:
- ConceptMap
summary: "search-type: Search for ConceptMap instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: other
in: query
description: canonical reference to an additional ConceptMap to use for mapping
if the source concept is unmapped
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: dependson
in: query
description: Reference to property mapping depends on
required: false
schema:
type: string
- name: target-system
in: query
description: Target system that the concepts are to be mapped to
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: source
in: query
description: The source value set that contains the concepts that are being
mapped
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: source-uri
in: query
description: The source value set that contains the concepts that are being
mapped
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: source-system
in: query
description: Source system where concepts to be mapped are defined
required: false
schema:
type: string
- name: target-code
in: query
description: Code that identifies the target element
required: false
schema:
type: string
- name: target-uri
in: query
description: The target value set which provides context for the mappings
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\
\ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\
\ External identifier for the structure map\r\n* [ValueSet](valueset.html):\
\ External identifier for the value set"
required: false
schema:
type: string
- name: product
in: query
description: Reference to property mapping depends on
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: target
in: query
description: The target value set which provides context for the mappings
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: source-code
in: query
description: Identifies element being mapped
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- ConceptMap
summary: "create-type: Create a new ConceptMap instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ConceptMap"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ConceptMap/_history:
get:
tags:
- ConceptMap
summary: "type-history: Fetch the resource change history for all resources\
\ of type ConceptMap"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ConceptMap/{id}/_history:
get:
tags:
- ConceptMap
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ConceptMap"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ConceptMap/_search:
get:
tags:
- ConceptMap
summary: "search-type: Search for ConceptMap instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: other
in: query
description: canonical reference to an additional ConceptMap to use for mapping
if the source concept is unmapped
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: dependson
in: query
description: Reference to property mapping depends on
required: false
schema:
type: string
- name: target-system
in: query
description: Target system that the concepts are to be mapped to
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: source
in: query
description: The source value set that contains the concepts that are being
mapped
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: source-uri
in: query
description: The source value set that contains the concepts that are being
mapped
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: source-system
in: query
description: Source system where concepts to be mapped are defined
required: false
schema:
type: string
- name: target-code
in: query
description: Code that identifies the target element
required: false
schema:
type: string
- name: target-uri
in: query
description: The target value set which provides context for the mappings
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\
\ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\
\ External identifier for the structure map\r\n* [ValueSet](valueset.html):\
\ External identifier for the value set"
required: false
schema:
type: string
- name: product
in: query
description: Reference to property mapping depends on
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: target
in: query
description: The target value set which provides context for the mappings
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: source-code
in: query
description: Identifies element being mapped
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ConceptMap/$validate:
get:
tags:
- ConceptMap
summary: "GET: /ConceptMap/$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:
- ConceptMap
summary: "POST: /ConceptMap/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ConceptMap",
"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"
/ConceptMap/{id}/$validate:
get:
tags:
- ConceptMap
summary: "GET: /ConceptMap/{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:
- ConceptMap
summary: "POST: /ConceptMap/{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": "ConceptMap",
"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"
/ConceptMap/{id}/$meta-delete:
post:
tags:
- ConceptMap
summary: "POST: /ConceptMap/{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"
/ConceptMap/{id}/$meta-add:
post:
tags:
- ConceptMap
summary: "POST: /ConceptMap/{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"
/ConceptMap/$meta:
get:
tags:
- ConceptMap
summary: "GET: /ConceptMap/$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:
- ConceptMap
summary: "POST: /ConceptMap/$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"
/ConceptMap/{id}/$meta:
get:
tags:
- ConceptMap
summary: "GET: /ConceptMap/{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:
- ConceptMap
summary: "POST: /ConceptMap/{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"
/ConceptMap/$expunge:
post:
tags:
- ConceptMap
summary: "POST: /ConceptMap/$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"
/ConceptMap/{id}/$expunge:
post:
tags:
- ConceptMap
summary: "POST: /ConceptMap/{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"
/ConceptMap/$translate:
get:
tags:
- ConceptMap
summary: "GET: /ConceptMap/$translate"
parameters:
- name: url
in: query
required: false
schema:
type: string
- name: conceptMapVersion
in: query
required: false
schema:
type: string
- name: code
in: query
required: false
schema:
type: string
- name: system
in: query
required: false
schema:
type: string
- name: version
in: query
required: false
schema:
type: string
- name: source
in: query
required: false
schema:
type: string
- name: coding
in: query
required: false
schema:
type: string
- name: target
in: query
required: false
schema:
type: string
- name: targetsystem
in: query
required: false
schema:
type: string
- name: reverse
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:
- ConceptMap
summary: "POST: /ConceptMap/$translate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueUri": "example"
}, {
"name": "conceptMapVersion",
"valueString": "example"
}, {
"name": "code",
"valueCode": "example"
}, {
"name": "system",
"valueUri": "example"
}, {
"name": "version",
"valueString": "example"
}, {
"name": "source",
"valueUri": "example"
}, {
"name": "coding",
"valueCoding": {
"system": "http://example.com",
"code": "1234"
}
}, {
"name": "codeableConcept",
"valueCodeableConcept": {
"coding": [ {
"system": "http://example.com",
"code": "1234"
} ]
}
}, {
"name": "target",
"valueUri": "example"
}, {
"name": "targetsystem",
"valueUri": "example"
}, {
"name": "reverse",
"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"
/ConceptMap/{id}/$translate:
get:
tags:
- ConceptMap
summary: "GET: /ConceptMap/{id}/$translate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: url
in: query
required: false
schema:
type: string
- name: conceptMapVersion
in: query
required: false
schema:
type: string
- name: code
in: query
required: false
schema:
type: string
- name: system
in: query
required: false
schema:
type: string
- name: version
in: query
required: false
schema:
type: string
- name: source
in: query
required: false
schema:
type: string
- name: coding
in: query
required: false
schema:
type: string
- name: target
in: query
required: false
schema:
type: string
- name: targetsystem
in: query
required: false
schema:
type: string
- name: reverse
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:
- ConceptMap
summary: "POST: /ConceptMap/{id}/$translate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueUri": "example"
}, {
"name": "conceptMapVersion",
"valueString": "example"
}, {
"name": "code",
"valueCode": "example"
}, {
"name": "system",
"valueUri": "example"
}, {
"name": "version",
"valueString": "example"
}, {
"name": "source",
"valueUri": "example"
}, {
"name": "coding",
"valueCoding": {
"system": "http://example.com",
"code": "1234"
}
}, {
"name": "codeableConcept",
"valueCodeableConcept": {
"coding": [ {
"system": "http://example.com",
"code": "1234"
} ]
}
}, {
"name": "target",
"valueUri": "example"
}, {
"name": "targetsystem",
"valueUri": "example"
}, {
"name": "reverse",
"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"
/ConceptMap/{id}/$diff:
get:
tags:
- ConceptMap
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:
- ConceptMap
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"
/Condition/{id}:
get:
tags:
- Condition
summary: "read-instance: Read Condition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Condition
summary: "update-instance: Update an existing Condition 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": "Condition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Condition
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:
- Condition
summary: "instance-patch: Patch a resource instance of type Condition 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"
/Condition/{id}/_history/{version_id}:
get:
tags:
- Condition
summary: "vread-instance: Read Condition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Condition:
get:
tags:
- Condition
summary: "search-type: Search for Condition instances"
description: This is a search type
parameters:
- name: onset-info
in: query
description: Onsets as a string
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: evidence
in: query
description: Manifestation/symptom
required: false
schema:
type: string
- name: subject
in: query
description: Who has the condition?
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: verification-status
in: query
description: unconfirmed | provisional | differential | confirmed | refuted
| entered-in-error
required: false
schema:
type: string
- name: clinical-status
in: query
description: The clinical status of the condition
required: false
schema:
type: string
- name: onset-date
in: query
description: Date related onsets (dateTime and Period)
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: abatement-date
in: query
description: Date-related abatements (dateTime and period)
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: abatement-age
in: query
description: Abatement as age or age range
required: false
schema:
anyOf:
- type: string
- type: number
- name: evidence-detail
in: query
description: Supporting information found elsewhere
required: false
schema:
type: string
- name: severity
in: query
description: The severity of the condition
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: recorded-date
in: query
description: Date record was first recorded
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: Encounter created as part of
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: asserter
in: query
description: Person who asserts this condition
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: stage
in: query
description: Simple summary (disease specific)
required: false
schema:
type: string
- name: abatement-string
in: query
description: Abatement as a string
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: onset-age
in: query
description: Onsets as age or age range
required: false
schema:
anyOf:
- type: string
- type: number
- 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: body-site
in: query
description: "Anatomical location, if relevant"
required: false
schema:
type: string
- name: category
in: query
description: The category of the condition
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:
- Condition
summary: "create-type: Create a new Condition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Condition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Condition/_history:
get:
tags:
- Condition
summary: "type-history: Fetch the resource change history for all resources\
\ of type Condition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Condition/{id}/_history:
get:
tags:
- Condition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Condition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Condition/_search:
get:
tags:
- Condition
summary: "search-type: Search for Condition instances"
description: This is a search type
parameters:
- name: onset-info
in: query
description: Onsets as a string
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: evidence
in: query
description: Manifestation/symptom
required: false
schema:
type: string
- name: subject
in: query
description: Who has the condition?
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: verification-status
in: query
description: unconfirmed | provisional | differential | confirmed | refuted
| entered-in-error
required: false
schema:
type: string
- name: clinical-status
in: query
description: The clinical status of the condition
required: false
schema:
type: string
- name: onset-date
in: query
description: Date related onsets (dateTime and Period)
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: abatement-date
in: query
description: Date-related abatements (dateTime and period)
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: abatement-age
in: query
description: Abatement as age or age range
required: false
schema:
anyOf:
- type: string
- type: number
- name: evidence-detail
in: query
description: Supporting information found elsewhere
required: false
schema:
type: string
- name: severity
in: query
description: The severity of the condition
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: recorded-date
in: query
description: Date record was first recorded
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: Encounter created as part of
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: asserter
in: query
description: Person who asserts this condition
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: stage
in: query
description: Simple summary (disease specific)
required: false
schema:
type: string
- name: abatement-string
in: query
description: Abatement as a string
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: onset-age
in: query
description: Onsets as age or age range
required: false
schema:
anyOf:
- type: string
- type: number
- 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: body-site
in: query
description: "Anatomical location, if relevant"
required: false
schema:
type: string
- name: category
in: query
description: The category of the condition
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"
/Condition/$validate:
get:
tags:
- Condition
summary: "GET: /Condition/$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:
- Condition
summary: "POST: /Condition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Condition",
"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"
/Condition/{id}/$validate:
get:
tags:
- Condition
summary: "GET: /Condition/{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:
- Condition
summary: "POST: /Condition/{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": "Condition",
"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"
/Condition/{id}/$meta-delete:
post:
tags:
- Condition
summary: "POST: /Condition/{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"
/Condition/{id}/$meta-add:
post:
tags:
- Condition
summary: "POST: /Condition/{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"
/Condition/$meta:
get:
tags:
- Condition
summary: "GET: /Condition/$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:
- Condition
summary: "POST: /Condition/$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"
/Condition/{id}/$meta:
get:
tags:
- Condition
summary: "GET: /Condition/{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:
- Condition
summary: "POST: /Condition/{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"
/Condition/$expunge:
post:
tags:
- Condition
summary: "POST: /Condition/$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"
/Condition/{id}/$expunge:
post:
tags:
- Condition
summary: "POST: /Condition/{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"
/Condition/{id}/$diff:
get:
tags:
- Condition
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:
- Condition
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"
/Consent/{id}:
get:
tags:
- Consent
summary: "read-instance: Read Consent instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Consent
summary: "update-instance: Update an existing Consent 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": "Consent"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Consent
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:
- Consent
summary: "instance-patch: Patch a resource instance of type Consent 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"
/Consent/{id}/_history/{version_id}:
get:
tags:
- Consent
summary: "vread-instance: Read Consent instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Consent:
get:
tags:
- Consent
summary: "search-type: Search for Consent instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: period
in: query
description: Timeframe for this rule
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: data
in: query
description: The actual data reference
required: false
schema:
type: string
- name: purpose
in: query
description: Context of activities covered by this rule
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: source-reference
in: query
description: "Search by reference to a Consent, DocumentReference, Contract\
\ or QuestionnaireResponse"
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: actor
in: query
description: "Resource for the actor (or group, by role)"
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: security-label
in: query
description: Security Labels that define affected resources
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: Custodian of the consent
required: false
schema:
type: string
- name: scope
in: query
description: Which of the four areas this resource covers (extensible)
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: action
in: query
description: Actions controlled by this rule
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: consentor
in: query
description: Who is agreeing to the policy and rules
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: Classification of the consent statement - for indexing/retrieval
required: false
schema:
type: string
- name: status
in: query
description: draft | proposed | active | rejected | inactive | entered-in-error
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:
- Consent
summary: "create-type: Create a new Consent instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Consent"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Consent/_history:
get:
tags:
- Consent
summary: "type-history: Fetch the resource change history for all resources\
\ of type Consent"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Consent/{id}/_history:
get:
tags:
- Consent
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Consent"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Consent/_search:
get:
tags:
- Consent
summary: "search-type: Search for Consent instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: period
in: query
description: Timeframe for this rule
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: data
in: query
description: The actual data reference
required: false
schema:
type: string
- name: purpose
in: query
description: Context of activities covered by this rule
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: source-reference
in: query
description: "Search by reference to a Consent, DocumentReference, Contract\
\ or QuestionnaireResponse"
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: actor
in: query
description: "Resource for the actor (or group, by role)"
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: security-label
in: query
description: Security Labels that define affected resources
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: Custodian of the consent
required: false
schema:
type: string
- name: scope
in: query
description: Which of the four areas this resource covers (extensible)
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: action
in: query
description: Actions controlled by this rule
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: consentor
in: query
description: Who is agreeing to the policy and rules
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: Classification of the consent statement - for indexing/retrieval
required: false
schema:
type: string
- name: status
in: query
description: draft | proposed | active | rejected | inactive | entered-in-error
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"
/Consent/$validate:
get:
tags:
- Consent
summary: "GET: /Consent/$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:
- Consent
summary: "POST: /Consent/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Consent",
"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"
/Consent/{id}/$validate:
get:
tags:
- Consent
summary: "GET: /Consent/{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:
- Consent
summary: "POST: /Consent/{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": "Consent",
"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"
/Consent/{id}/$meta-delete:
post:
tags:
- Consent
summary: "POST: /Consent/{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"
/Consent/{id}/$meta-add:
post:
tags:
- Consent
summary: "POST: /Consent/{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"
/Consent/$meta:
get:
tags:
- Consent
summary: "GET: /Consent/$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:
- Consent
summary: "POST: /Consent/$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"
/Consent/{id}/$meta:
get:
tags:
- Consent
summary: "GET: /Consent/{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:
- Consent
summary: "POST: /Consent/{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"
/Consent/$expunge:
post:
tags:
- Consent
summary: "POST: /Consent/$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"
/Consent/{id}/$expunge:
post:
tags:
- Consent
summary: "POST: /Consent/{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"
/Consent/{id}/$diff:
get:
tags:
- Consent
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:
- Consent
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"
/Contract/{id}:
get:
tags:
- Contract
summary: "read-instance: Read Contract instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Contract
summary: "update-instance: Update an existing Contract 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": "Contract"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Contract
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:
- Contract
summary: "instance-patch: Patch a resource instance of type Contract 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"
/Contract/{id}/_history/{version_id}:
get:
tags:
- Contract
summary: "vread-instance: Read Contract instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Contract:
get:
tags:
- Contract
summary: "search-type: Search for Contract instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The identity of the contract
required: false
schema:
type: string
- name: instantiates
in: query
description: A source definition of the contract
required: false
schema:
type: string
- name: subject
in: query
description: The identity of the subject of the contract
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: url
in: query
description: The basal contract definition
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 identity of the subject of the contract (if a patient)
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: authority
in: query
description: The authority of the contract
required: false
schema:
type: string
- name: domain
in: query
description: The domain of the contract
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: issued
in: query
description: The date/time the contract was issued
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: signer
in: query
description: Contract Signatory Party
required: false
schema:
type: string
- name: status
in: query
description: The status of the contract
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:
- Contract
summary: "create-type: Create a new Contract instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Contract"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Contract/_history:
get:
tags:
- Contract
summary: "type-history: Fetch the resource change history for all resources\
\ of type Contract"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Contract/{id}/_history:
get:
tags:
- Contract
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Contract"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Contract/_search:
get:
tags:
- Contract
summary: "search-type: Search for Contract instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The identity of the contract
required: false
schema:
type: string
- name: instantiates
in: query
description: A source definition of the contract
required: false
schema:
type: string
- name: subject
in: query
description: The identity of the subject of the contract
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: url
in: query
description: The basal contract definition
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 identity of the subject of the contract (if a patient)
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: authority
in: query
description: The authority of the contract
required: false
schema:
type: string
- name: domain
in: query
description: The domain of the contract
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: issued
in: query
description: The date/time the contract was issued
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: signer
in: query
description: Contract Signatory Party
required: false
schema:
type: string
- name: status
in: query
description: The status of the contract
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"
/Contract/$validate:
get:
tags:
- Contract
summary: "GET: /Contract/$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:
- Contract
summary: "POST: /Contract/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Contract",
"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"
/Contract/{id}/$validate:
get:
tags:
- Contract
summary: "GET: /Contract/{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:
- Contract
summary: "POST: /Contract/{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": "Contract",
"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"
/Contract/{id}/$meta-delete:
post:
tags:
- Contract
summary: "POST: /Contract/{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"
/Contract/{id}/$meta-add:
post:
tags:
- Contract
summary: "POST: /Contract/{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"
/Contract/$meta:
get:
tags:
- Contract
summary: "GET: /Contract/$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:
- Contract
summary: "POST: /Contract/$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"
/Contract/{id}/$meta:
get:
tags:
- Contract
summary: "GET: /Contract/{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:
- Contract
summary: "POST: /Contract/{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"
/Contract/$expunge:
post:
tags:
- Contract
summary: "POST: /Contract/$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"
/Contract/{id}/$expunge:
post:
tags:
- Contract
summary: "POST: /Contract/{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"
/Contract/{id}/$diff:
get:
tags:
- Contract
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:
- Contract
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"
/Coverage/{id}:
get:
tags:
- Coverage
summary: "read-instance: Read Coverage instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Coverage
summary: "update-instance: Update an existing Coverage 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": "Coverage"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Coverage
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:
- Coverage
summary: "instance-patch: Patch a resource instance of type Coverage 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"
/Coverage/{id}/_history/{version_id}:
get:
tags:
- Coverage
summary: "vread-instance: Read Coverage instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Coverage:
get:
tags:
- Coverage
summary: "search-type: Search for Coverage instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The primary identifier of the insured and the coverage
required: false
schema:
type: string
- name: subscriber
in: query
description: Reference to the subscriber
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: "The kind of coverage (health plan, auto, Workers Compensation)"
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: payor
in: query
description: The identity of the insurer or party paying for services
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: beneficiary
in: query
description: Covered party
required: false
schema:
type: string
- name: patient
in: query
description: Retrieve coverages for a patient
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: class-value
in: query
description: "Value of the class (eg. Plan number, group number)"
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: class-type
in: query
description: "Coverage class (eg. plan, group)"
required: false
schema:
type: string
- name: dependent
in: query
description: Dependent number
required: false
schema:
type: string
- name: policy-holder
in: query
description: Reference to the policyholder
required: false
schema:
type: string
- name: status
in: query
description: The status of the Coverage
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:
- Coverage
summary: "create-type: Create a new Coverage instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Coverage"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Coverage/_history:
get:
tags:
- Coverage
summary: "type-history: Fetch the resource change history for all resources\
\ of type Coverage"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Coverage/{id}/_history:
get:
tags:
- Coverage
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Coverage"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Coverage/_search:
get:
tags:
- Coverage
summary: "search-type: Search for Coverage instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The primary identifier of the insured and the coverage
required: false
schema:
type: string
- name: subscriber
in: query
description: Reference to the subscriber
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: "The kind of coverage (health plan, auto, Workers Compensation)"
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: payor
in: query
description: The identity of the insurer or party paying for services
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: beneficiary
in: query
description: Covered party
required: false
schema:
type: string
- name: patient
in: query
description: Retrieve coverages for a patient
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: class-value
in: query
description: "Value of the class (eg. Plan number, group number)"
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: class-type
in: query
description: "Coverage class (eg. plan, group)"
required: false
schema:
type: string
- name: dependent
in: query
description: Dependent number
required: false
schema:
type: string
- name: policy-holder
in: query
description: Reference to the policyholder
required: false
schema:
type: string
- name: status
in: query
description: The status of the Coverage
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"
/Coverage/$validate:
get:
tags:
- Coverage
summary: "GET: /Coverage/$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:
- Coverage
summary: "POST: /Coverage/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Coverage",
"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"
/Coverage/{id}/$validate:
get:
tags:
- Coverage
summary: "GET: /Coverage/{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:
- Coverage
summary: "POST: /Coverage/{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": "Coverage",
"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"
/Coverage/{id}/$meta-delete:
post:
tags:
- Coverage
summary: "POST: /Coverage/{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"
/Coverage/{id}/$meta-add:
post:
tags:
- Coverage
summary: "POST: /Coverage/{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"
/Coverage/$meta:
get:
tags:
- Coverage
summary: "GET: /Coverage/$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:
- Coverage
summary: "POST: /Coverage/$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"
/Coverage/{id}/$meta:
get:
tags:
- Coverage
summary: "GET: /Coverage/{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:
- Coverage
summary: "POST: /Coverage/{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"
/Coverage/$expunge:
post:
tags:
- Coverage
summary: "POST: /Coverage/$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"
/Coverage/{id}/$expunge:
post:
tags:
- Coverage
summary: "POST: /Coverage/{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"
/Coverage/{id}/$diff:
get:
tags:
- Coverage
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:
- Coverage
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"
/CoverageEligibilityRequest/{id}:
get:
tags:
- CoverageEligibilityRequest
summary: "read-instance: Read CoverageEligibilityRequest instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- CoverageEligibilityRequest
summary: "update-instance: Update an existing CoverageEligibilityRequest 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": "CoverageEligibilityRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- CoverageEligibilityRequest
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:
- CoverageEligibilityRequest
summary: "instance-patch: Patch a resource instance of type CoverageEligibilityRequest\
\ 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"
/CoverageEligibilityRequest/{id}/_history/{version_id}:
get:
tags:
- CoverageEligibilityRequest
summary: "vread-instance: Read CoverageEligibilityRequest instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CoverageEligibilityRequest:
get:
tags:
- CoverageEligibilityRequest
summary: "search-type: Search for CoverageEligibilityRequest instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier of the Eligibility
required: false
schema:
type: string
- name: created
in: query
description: The creation date for the EOB
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: provider
in: query
description: The reference to the provider
required: false
schema:
type: string
- name: patient
in: query
description: The reference to the patient
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: enterer
in: query
description: The party who is responsible for the request
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: facility
in: query
description: Facility responsible for the goods and services
required: false
schema:
type: string
- name: status
in: query
description: The status of the EligibilityRequest
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:
- CoverageEligibilityRequest
summary: "create-type: Create a new CoverageEligibilityRequest instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "CoverageEligibilityRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CoverageEligibilityRequest/_history:
get:
tags:
- CoverageEligibilityRequest
summary: "type-history: Fetch the resource change history for all resources\
\ of type CoverageEligibilityRequest"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CoverageEligibilityRequest/{id}/_history:
get:
tags:
- CoverageEligibilityRequest
summary: "instance-history: Fetch the resource change history for all resources\
\ of type CoverageEligibilityRequest"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CoverageEligibilityRequest/_search:
get:
tags:
- CoverageEligibilityRequest
summary: "search-type: Search for CoverageEligibilityRequest instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier of the Eligibility
required: false
schema:
type: string
- name: created
in: query
description: The creation date for the EOB
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: provider
in: query
description: The reference to the provider
required: false
schema:
type: string
- name: patient
in: query
description: The reference to the patient
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: enterer
in: query
description: The party who is responsible for the request
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: facility
in: query
description: Facility responsible for the goods and services
required: false
schema:
type: string
- name: status
in: query
description: The status of the EligibilityRequest
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"
/CoverageEligibilityRequest/$validate:
get:
tags:
- CoverageEligibilityRequest
summary: "GET: /CoverageEligibilityRequest/$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:
- CoverageEligibilityRequest
summary: "POST: /CoverageEligibilityRequest/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "CoverageEligibilityRequest",
"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"
/CoverageEligibilityRequest/{id}/$validate:
get:
tags:
- CoverageEligibilityRequest
summary: "GET: /CoverageEligibilityRequest/{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:
- CoverageEligibilityRequest
summary: "POST: /CoverageEligibilityRequest/{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": "CoverageEligibilityRequest",
"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"
/CoverageEligibilityRequest/{id}/$meta-delete:
post:
tags:
- CoverageEligibilityRequest
summary: "POST: /CoverageEligibilityRequest/{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"
/CoverageEligibilityRequest/{id}/$meta-add:
post:
tags:
- CoverageEligibilityRequest
summary: "POST: /CoverageEligibilityRequest/{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"
/CoverageEligibilityRequest/$meta:
get:
tags:
- CoverageEligibilityRequest
summary: "GET: /CoverageEligibilityRequest/$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:
- CoverageEligibilityRequest
summary: "POST: /CoverageEligibilityRequest/$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"
/CoverageEligibilityRequest/{id}/$meta:
get:
tags:
- CoverageEligibilityRequest
summary: "GET: /CoverageEligibilityRequest/{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:
- CoverageEligibilityRequest
summary: "POST: /CoverageEligibilityRequest/{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"
/CoverageEligibilityRequest/$expunge:
post:
tags:
- CoverageEligibilityRequest
summary: "POST: /CoverageEligibilityRequest/$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"
/CoverageEligibilityRequest/{id}/$expunge:
post:
tags:
- CoverageEligibilityRequest
summary: "POST: /CoverageEligibilityRequest/{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"
/CoverageEligibilityRequest/{id}/$diff:
get:
tags:
- CoverageEligibilityRequest
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:
- CoverageEligibilityRequest
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"
/CoverageEligibilityResponse/{id}:
get:
tags:
- CoverageEligibilityResponse
summary: "read-instance: Read CoverageEligibilityResponse instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- CoverageEligibilityResponse
summary: "update-instance: Update an existing CoverageEligibilityResponse 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": "CoverageEligibilityResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- CoverageEligibilityResponse
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:
- CoverageEligibilityResponse
summary: "instance-patch: Patch a resource instance of type CoverageEligibilityResponse\
\ 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"
/CoverageEligibilityResponse/{id}/_history/{version_id}:
get:
tags:
- CoverageEligibilityResponse
summary: "vread-instance: Read CoverageEligibilityResponse instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CoverageEligibilityResponse:
get:
tags:
- CoverageEligibilityResponse
summary: "search-type: Search for CoverageEligibilityResponse instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier
required: false
schema:
type: string
- name: request
in: query
description: The EligibilityRequest reference
required: false
schema:
type: string
- name: created
in: query
description: The creation date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: requestor
in: query
description: The EligibilityRequest provider
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: disposition
in: query
description: The contents of the disposition message
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: insurer
in: query
description: The organization which generated this resource
required: false
schema:
type: string
- name: patient
in: query
description: The reference to the patient
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: outcome
in: query
description: The processing outcome
required: false
schema:
type: string
- name: status
in: query
description: The EligibilityRequest status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- CoverageEligibilityResponse
summary: "create-type: Create a new CoverageEligibilityResponse instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "CoverageEligibilityResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CoverageEligibilityResponse/_history:
get:
tags:
- CoverageEligibilityResponse
summary: "type-history: Fetch the resource change history for all resources\
\ of type CoverageEligibilityResponse"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CoverageEligibilityResponse/{id}/_history:
get:
tags:
- CoverageEligibilityResponse
summary: "instance-history: Fetch the resource change history for all resources\
\ of type CoverageEligibilityResponse"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CoverageEligibilityResponse/_search:
get:
tags:
- CoverageEligibilityResponse
summary: "search-type: Search for CoverageEligibilityResponse instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier
required: false
schema:
type: string
- name: request
in: query
description: The EligibilityRequest reference
required: false
schema:
type: string
- name: created
in: query
description: The creation date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: requestor
in: query
description: The EligibilityRequest provider
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: disposition
in: query
description: The contents of the disposition message
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: insurer
in: query
description: The organization which generated this resource
required: false
schema:
type: string
- name: patient
in: query
description: The reference to the patient
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: outcome
in: query
description: The processing outcome
required: false
schema:
type: string
- name: status
in: query
description: The EligibilityRequest status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/CoverageEligibilityResponse/$validate:
get:
tags:
- CoverageEligibilityResponse
summary: "GET: /CoverageEligibilityResponse/$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:
- CoverageEligibilityResponse
summary: "POST: /CoverageEligibilityResponse/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "CoverageEligibilityResponse",
"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"
/CoverageEligibilityResponse/{id}/$validate:
get:
tags:
- CoverageEligibilityResponse
summary: "GET: /CoverageEligibilityResponse/{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:
- CoverageEligibilityResponse
summary: "POST: /CoverageEligibilityResponse/{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": "CoverageEligibilityResponse",
"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"
/CoverageEligibilityResponse/{id}/$meta-delete:
post:
tags:
- CoverageEligibilityResponse
summary: "POST: /CoverageEligibilityResponse/{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"
/CoverageEligibilityResponse/{id}/$meta-add:
post:
tags:
- CoverageEligibilityResponse
summary: "POST: /CoverageEligibilityResponse/{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"
/CoverageEligibilityResponse/$meta:
get:
tags:
- CoverageEligibilityResponse
summary: "GET: /CoverageEligibilityResponse/$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:
- CoverageEligibilityResponse
summary: "POST: /CoverageEligibilityResponse/$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"
/CoverageEligibilityResponse/{id}/$meta:
get:
tags:
- CoverageEligibilityResponse
summary: "GET: /CoverageEligibilityResponse/{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:
- CoverageEligibilityResponse
summary: "POST: /CoverageEligibilityResponse/{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"
/CoverageEligibilityResponse/$expunge:
post:
tags:
- CoverageEligibilityResponse
summary: "POST: /CoverageEligibilityResponse/$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"
/CoverageEligibilityResponse/{id}/$expunge:
post:
tags:
- CoverageEligibilityResponse
summary: "POST: /CoverageEligibilityResponse/{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"
/CoverageEligibilityResponse/{id}/$diff:
get:
tags:
- CoverageEligibilityResponse
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:
- CoverageEligibilityResponse
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"
/DetectedIssue/{id}:
get:
tags:
- DetectedIssue
summary: "read-instance: Read DetectedIssue instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- DetectedIssue
summary: "update-instance: Update an existing DetectedIssue 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": "DetectedIssue"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- DetectedIssue
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:
- DetectedIssue
summary: "instance-patch: Patch a resource instance of type DetectedIssue 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"
/DetectedIssue/{id}/_history/{version_id}:
get:
tags:
- DetectedIssue
summary: "vread-instance: Read DetectedIssue instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DetectedIssue:
get:
tags:
- DetectedIssue
summary: "search-type: Search for DetectedIssue instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: code
in: query
description: "Issue Category, e.g. drug-drug, duplicate therapy, etc."
required: false
schema:
type: string
- name: author
in: query
description: The provider or device that identified the issue
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: identified
in: query
description: When identified
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: implicated
in: query
description: Problem resource
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DetectedIssue
summary: "create-type: Create a new DetectedIssue instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "DetectedIssue"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DetectedIssue/_history:
get:
tags:
- DetectedIssue
summary: "type-history: Fetch the resource change history for all resources\
\ of type DetectedIssue"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DetectedIssue/{id}/_history:
get:
tags:
- DetectedIssue
summary: "instance-history: Fetch the resource change history for all resources\
\ of type DetectedIssue"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DetectedIssue/_search:
get:
tags:
- DetectedIssue
summary: "search-type: Search for DetectedIssue instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: code
in: query
description: "Issue Category, e.g. drug-drug, duplicate therapy, etc."
required: false
schema:
type: string
- name: author
in: query
description: The provider or device that identified the issue
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: identified
in: query
description: When identified
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: implicated
in: query
description: Problem resource
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DetectedIssue/$validate:
get:
tags:
- DetectedIssue
summary: "GET: /DetectedIssue/$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:
- DetectedIssue
summary: "POST: /DetectedIssue/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "DetectedIssue",
"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"
/DetectedIssue/{id}/$validate:
get:
tags:
- DetectedIssue
summary: "GET: /DetectedIssue/{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:
- DetectedIssue
summary: "POST: /DetectedIssue/{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": "DetectedIssue",
"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"
/DetectedIssue/{id}/$meta-delete:
post:
tags:
- DetectedIssue
summary: "POST: /DetectedIssue/{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"
/DetectedIssue/{id}/$meta-add:
post:
tags:
- DetectedIssue
summary: "POST: /DetectedIssue/{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"
/DetectedIssue/$meta:
get:
tags:
- DetectedIssue
summary: "GET: /DetectedIssue/$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:
- DetectedIssue
summary: "POST: /DetectedIssue/$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"
/DetectedIssue/{id}/$meta:
get:
tags:
- DetectedIssue
summary: "GET: /DetectedIssue/{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:
- DetectedIssue
summary: "POST: /DetectedIssue/{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"
/DetectedIssue/$expunge:
post:
tags:
- DetectedIssue
summary: "POST: /DetectedIssue/$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"
/DetectedIssue/{id}/$expunge:
post:
tags:
- DetectedIssue
summary: "POST: /DetectedIssue/{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"
/DetectedIssue/{id}/$diff:
get:
tags:
- DetectedIssue
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:
- DetectedIssue
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"
/Device/{id}:
get:
tags:
- Device
summary: "read-instance: Read Device instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Device
summary: "update-instance: Update an existing Device 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": "Device"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Device
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:
- Device
summary: "instance-patch: Patch a resource instance of type Device 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"
/Device/{id}/_history/{version_id}:
get:
tags:
- Device
summary: "vread-instance: Read Device instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Device:
get:
tags:
- Device
summary: "search-type: Search for Device instances"
description: This is a search type
parameters:
- name: udi-di
in: query
description: The udi Device Identifier (DI)
required: false
schema:
type: string
- name: identifier
in: query
description: "Instance id from manufacturer, owner, and others"
required: false
schema:
type: string
- name: udi-carrier
in: query
description: UDI Barcode (RFID or other technology) string in *HRF* format.
required: false
schema:
type: string
- name: device-name
in: query
description: A server defined search that may match any of the string fields
in Device.deviceName or Device.type.
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: The type of the device
required: false
schema:
type: string
- name: url
in: query
description: Network address to contact device
required: false
schema:
type: string
- name: manufacturer
in: query
description: The manufacturer of the device
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: "Patient information, if the resource is affixed to a person"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The organization responsible for the device
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: location
in: query
description: "A location, where the resource is found"
required: false
schema:
type: string
- name: model
in: query
description: The model of the device
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: active | inactive | entered-in-error | unknown
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:
- Device
summary: "create-type: Create a new Device instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Device"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Device/_history:
get:
tags:
- Device
summary: "type-history: Fetch the resource change history for all resources\
\ of type Device"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Device/{id}/_history:
get:
tags:
- Device
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Device"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Device/_search:
get:
tags:
- Device
summary: "search-type: Search for Device instances"
description: This is a search type
parameters:
- name: udi-di
in: query
description: The udi Device Identifier (DI)
required: false
schema:
type: string
- name: identifier
in: query
description: "Instance id from manufacturer, owner, and others"
required: false
schema:
type: string
- name: udi-carrier
in: query
description: UDI Barcode (RFID or other technology) string in *HRF* format.
required: false
schema:
type: string
- name: device-name
in: query
description: A server defined search that may match any of the string fields
in Device.deviceName or Device.type.
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: The type of the device
required: false
schema:
type: string
- name: url
in: query
description: Network address to contact device
required: false
schema:
type: string
- name: manufacturer
in: query
description: The manufacturer of the device
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: "Patient information, if the resource is affixed to a person"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The organization responsible for the device
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: location
in: query
description: "A location, where the resource is found"
required: false
schema:
type: string
- name: model
in: query
description: The model of the device
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: active | inactive | entered-in-error | unknown
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"
/Device/$validate:
get:
tags:
- Device
summary: "GET: /Device/$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:
- Device
summary: "POST: /Device/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Device",
"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"
/Device/{id}/$validate:
get:
tags:
- Device
summary: "GET: /Device/{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:
- Device
summary: "POST: /Device/{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": "Device",
"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"
/Device/{id}/$meta-delete:
post:
tags:
- Device
summary: "POST: /Device/{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"
/Device/{id}/$meta-add:
post:
tags:
- Device
summary: "POST: /Device/{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"
/Device/$meta:
get:
tags:
- Device
summary: "GET: /Device/$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:
- Device
summary: "POST: /Device/$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"
/Device/{id}/$meta:
get:
tags:
- Device
summary: "GET: /Device/{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:
- Device
summary: "POST: /Device/{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"
/Device/$expunge:
post:
tags:
- Device
summary: "POST: /Device/$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"
/Device/{id}/$expunge:
post:
tags:
- Device
summary: "POST: /Device/{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"
/Device/{id}/$diff:
get:
tags:
- Device
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:
- Device
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"
/DeviceDefinition/{id}:
get:
tags:
- DeviceDefinition
summary: "read-instance: Read DeviceDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- DeviceDefinition
summary: "update-instance: Update an existing DeviceDefinition 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": "DeviceDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- DeviceDefinition
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:
- DeviceDefinition
summary: "instance-patch: Patch a resource instance of type DeviceDefinition\
\ 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"
/DeviceDefinition/{id}/_history/{version_id}:
get:
tags:
- DeviceDefinition
summary: "vread-instance: Read DeviceDefinition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceDefinition:
get:
tags:
- DeviceDefinition
summary: "search-type: Search for DeviceDefinition instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: identifier
in: query
description: The identifier of the component
required: false
schema:
type: string
- name: parent
in: query
description: The parent DeviceDefinition resource
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
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: _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: _security
in: query
description: Security Labels applied to this resource
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: type
in: query
description: The device component type
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DeviceDefinition
summary: "create-type: Create a new DeviceDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "DeviceDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceDefinition/_history:
get:
tags:
- DeviceDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type DeviceDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceDefinition/{id}/_history:
get:
tags:
- DeviceDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type DeviceDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceDefinition/_search:
get:
tags:
- DeviceDefinition
summary: "search-type: Search for DeviceDefinition instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: identifier
in: query
description: The identifier of the component
required: false
schema:
type: string
- name: parent
in: query
description: The parent DeviceDefinition resource
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
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: _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: _security
in: query
description: Security Labels applied to this resource
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: type
in: query
description: The device component type
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceDefinition/$validate:
get:
tags:
- DeviceDefinition
summary: "GET: /DeviceDefinition/$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:
- DeviceDefinition
summary: "POST: /DeviceDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "DeviceDefinition",
"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"
/DeviceDefinition/{id}/$validate:
get:
tags:
- DeviceDefinition
summary: "GET: /DeviceDefinition/{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:
- DeviceDefinition
summary: "POST: /DeviceDefinition/{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": "DeviceDefinition",
"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"
/DeviceDefinition/{id}/$meta-delete:
post:
tags:
- DeviceDefinition
summary: "POST: /DeviceDefinition/{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"
/DeviceDefinition/{id}/$meta-add:
post:
tags:
- DeviceDefinition
summary: "POST: /DeviceDefinition/{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"
/DeviceDefinition/$meta:
get:
tags:
- DeviceDefinition
summary: "GET: /DeviceDefinition/$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:
- DeviceDefinition
summary: "POST: /DeviceDefinition/$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"
/DeviceDefinition/{id}/$meta:
get:
tags:
- DeviceDefinition
summary: "GET: /DeviceDefinition/{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:
- DeviceDefinition
summary: "POST: /DeviceDefinition/{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"
/DeviceDefinition/$expunge:
post:
tags:
- DeviceDefinition
summary: "POST: /DeviceDefinition/$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"
/DeviceDefinition/{id}/$expunge:
post:
tags:
- DeviceDefinition
summary: "POST: /DeviceDefinition/{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"
/DeviceDefinition/{id}/$diff:
get:
tags:
- DeviceDefinition
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:
- DeviceDefinition
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"
/DeviceMetric/{id}:
get:
tags:
- DeviceMetric
summary: "read-instance: Read DeviceMetric instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- DeviceMetric
summary: "update-instance: Update an existing DeviceMetric 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": "DeviceMetric"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- DeviceMetric
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:
- DeviceMetric
summary: "instance-patch: Patch a resource instance of type DeviceMetric 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"
/DeviceMetric/{id}/_history/{version_id}:
get:
tags:
- DeviceMetric
summary: "vread-instance: Read DeviceMetric instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceMetric:
get:
tags:
- DeviceMetric
summary: "search-type: Search for DeviceMetric instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The identifier of the metric
required: false
schema:
type: string
- name: parent
in: query
description: The parent DeviceMetric resource
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: source
in: query
description: The device resource
required: false
schema:
type: string
- name: type
in: query
description: The component type
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: category
in: query
description: The category of the metric
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:
- DeviceMetric
summary: "create-type: Create a new DeviceMetric instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "DeviceMetric"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceMetric/_history:
get:
tags:
- DeviceMetric
summary: "type-history: Fetch the resource change history for all resources\
\ of type DeviceMetric"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceMetric/{id}/_history:
get:
tags:
- DeviceMetric
summary: "instance-history: Fetch the resource change history for all resources\
\ of type DeviceMetric"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceMetric/_search:
get:
tags:
- DeviceMetric
summary: "search-type: Search for DeviceMetric instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The identifier of the metric
required: false
schema:
type: string
- name: parent
in: query
description: The parent DeviceMetric resource
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: source
in: query
description: The device resource
required: false
schema:
type: string
- name: type
in: query
description: The component type
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: category
in: query
description: The category of the metric
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"
/DeviceMetric/$validate:
get:
tags:
- DeviceMetric
summary: "GET: /DeviceMetric/$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:
- DeviceMetric
summary: "POST: /DeviceMetric/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "DeviceMetric",
"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"
/DeviceMetric/{id}/$validate:
get:
tags:
- DeviceMetric
summary: "GET: /DeviceMetric/{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:
- DeviceMetric
summary: "POST: /DeviceMetric/{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": "DeviceMetric",
"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"
/DeviceMetric/{id}/$meta-delete:
post:
tags:
- DeviceMetric
summary: "POST: /DeviceMetric/{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"
/DeviceMetric/{id}/$meta-add:
post:
tags:
- DeviceMetric
summary: "POST: /DeviceMetric/{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"
/DeviceMetric/$meta:
get:
tags:
- DeviceMetric
summary: "GET: /DeviceMetric/$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:
- DeviceMetric
summary: "POST: /DeviceMetric/$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"
/DeviceMetric/{id}/$meta:
get:
tags:
- DeviceMetric
summary: "GET: /DeviceMetric/{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:
- DeviceMetric
summary: "POST: /DeviceMetric/{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"
/DeviceMetric/$expunge:
post:
tags:
- DeviceMetric
summary: "POST: /DeviceMetric/$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"
/DeviceMetric/{id}/$expunge:
post:
tags:
- DeviceMetric
summary: "POST: /DeviceMetric/{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"
/DeviceMetric/{id}/$diff:
get:
tags:
- DeviceMetric
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:
- DeviceMetric
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"
/DeviceRequest/{id}:
get:
tags:
- DeviceRequest
summary: "read-instance: Read DeviceRequest instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- DeviceRequest
summary: "update-instance: Update an existing DeviceRequest 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": "DeviceRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- DeviceRequest
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:
- DeviceRequest
summary: "instance-patch: Patch a resource instance of type DeviceRequest 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"
/DeviceRequest/{id}/_history/{version_id}:
get:
tags:
- DeviceRequest
summary: "vread-instance: Read DeviceRequest instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceRequest:
get:
tags:
- DeviceRequest
summary: "search-type: Search for DeviceRequest instances"
description: This is a search type
parameters:
- name: insurance
in: query
description: Associated insurance coverage
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: subject
in: query
description: Individual the service is ordered for
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: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: group-identifier
in: query
description: Composite request this is part of
required: false
schema:
type: string
- name: based-on
in: query
description: Plan/proposal/order fulfilled by this request
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
required: false
schema:
type: string
- name: requester
in: query
description: Who/what is requesting service
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: performer
in: query
description: Desired performer for service
required: false
schema:
type: string
- name: event-date
in: query
description: When service should occur
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: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: authored-on
in: query
description: When the request transitioned to being actionable
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: intent
in: query
description: proposal | plan | original-order |reflex-order
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: device
in: query
description: Reference to resource that is being requested/ordered
required: false
schema:
type: string
- name: prior-request
in: query
description: Request takes the place of referenced completed or terminated
requests
required: false
schema:
type: string
- name: status
in: query
description: entered-in-error | draft | active |suspended | completed
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:
- DeviceRequest
summary: "create-type: Create a new DeviceRequest instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "DeviceRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceRequest/_history:
get:
tags:
- DeviceRequest
summary: "type-history: Fetch the resource change history for all resources\
\ of type DeviceRequest"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceRequest/{id}/_history:
get:
tags:
- DeviceRequest
summary: "instance-history: Fetch the resource change history for all resources\
\ of type DeviceRequest"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceRequest/_search:
get:
tags:
- DeviceRequest
summary: "search-type: Search for DeviceRequest instances"
description: This is a search type
parameters:
- name: insurance
in: query
description: Associated insurance coverage
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: subject
in: query
description: Individual the service is ordered for
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: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: group-identifier
in: query
description: Composite request this is part of
required: false
schema:
type: string
- name: based-on
in: query
description: Plan/proposal/order fulfilled by this request
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
required: false
schema:
type: string
- name: requester
in: query
description: Who/what is requesting service
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: performer
in: query
description: Desired performer for service
required: false
schema:
type: string
- name: event-date
in: query
description: When service should occur
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: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: authored-on
in: query
description: When the request transitioned to being actionable
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: intent
in: query
description: proposal | plan | original-order |reflex-order
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: device
in: query
description: Reference to resource that is being requested/ordered
required: false
schema:
type: string
- name: prior-request
in: query
description: Request takes the place of referenced completed or terminated
requests
required: false
schema:
type: string
- name: status
in: query
description: entered-in-error | draft | active |suspended | completed
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"
/DeviceRequest/$validate:
get:
tags:
- DeviceRequest
summary: "GET: /DeviceRequest/$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:
- DeviceRequest
summary: "POST: /DeviceRequest/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "DeviceRequest",
"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"
/DeviceRequest/{id}/$validate:
get:
tags:
- DeviceRequest
summary: "GET: /DeviceRequest/{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:
- DeviceRequest
summary: "POST: /DeviceRequest/{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": "DeviceRequest",
"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"
/DeviceRequest/{id}/$meta-delete:
post:
tags:
- DeviceRequest
summary: "POST: /DeviceRequest/{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"
/DeviceRequest/{id}/$meta-add:
post:
tags:
- DeviceRequest
summary: "POST: /DeviceRequest/{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"
/DeviceRequest/$meta:
get:
tags:
- DeviceRequest
summary: "GET: /DeviceRequest/$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:
- DeviceRequest
summary: "POST: /DeviceRequest/$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"
/DeviceRequest/{id}/$meta:
get:
tags:
- DeviceRequest
summary: "GET: /DeviceRequest/{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:
- DeviceRequest
summary: "POST: /DeviceRequest/{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"
/DeviceRequest/$expunge:
post:
tags:
- DeviceRequest
summary: "POST: /DeviceRequest/$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"
/DeviceRequest/{id}/$expunge:
post:
tags:
- DeviceRequest
summary: "POST: /DeviceRequest/{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"
/DeviceRequest/{id}/$diff:
get:
tags:
- DeviceRequest
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:
- DeviceRequest
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"
/DeviceUseStatement/{id}:
get:
tags:
- DeviceUseStatement
summary: "read-instance: Read DeviceUseStatement instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- DeviceUseStatement
summary: "update-instance: Update an existing DeviceUseStatement 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": "DeviceUseStatement"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- DeviceUseStatement
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:
- DeviceUseStatement
summary: "instance-patch: Patch a resource instance of type DeviceUseStatement\
\ 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"
/DeviceUseStatement/{id}/_history/{version_id}:
get:
tags:
- DeviceUseStatement
summary: "vread-instance: Read DeviceUseStatement instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceUseStatement:
get:
tags:
- DeviceUseStatement
summary: "search-type: Search for DeviceUseStatement instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Search by identifier
required: false
schema:
type: string
- name: subject
in: query
description: Search by subject
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: device
in: query
description: Search by device
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:
- DeviceUseStatement
summary: "create-type: Create a new DeviceUseStatement instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "DeviceUseStatement"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceUseStatement/_history:
get:
tags:
- DeviceUseStatement
summary: "type-history: Fetch the resource change history for all resources\
\ of type DeviceUseStatement"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceUseStatement/{id}/_history:
get:
tags:
- DeviceUseStatement
summary: "instance-history: Fetch the resource change history for all resources\
\ of type DeviceUseStatement"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DeviceUseStatement/_search:
get:
tags:
- DeviceUseStatement
summary: "search-type: Search for DeviceUseStatement instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Search by identifier
required: false
schema:
type: string
- name: subject
in: query
description: Search by subject
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: device
in: query
description: Search by device
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"
/DeviceUseStatement/$validate:
get:
tags:
- DeviceUseStatement
summary: "GET: /DeviceUseStatement/$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:
- DeviceUseStatement
summary: "POST: /DeviceUseStatement/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "DeviceUseStatement",
"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"
/DeviceUseStatement/{id}/$validate:
get:
tags:
- DeviceUseStatement
summary: "GET: /DeviceUseStatement/{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:
- DeviceUseStatement
summary: "POST: /DeviceUseStatement/{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": "DeviceUseStatement",
"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"
/DeviceUseStatement/{id}/$meta-delete:
post:
tags:
- DeviceUseStatement
summary: "POST: /DeviceUseStatement/{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"
/DeviceUseStatement/{id}/$meta-add:
post:
tags:
- DeviceUseStatement
summary: "POST: /DeviceUseStatement/{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"
/DeviceUseStatement/$meta:
get:
tags:
- DeviceUseStatement
summary: "GET: /DeviceUseStatement/$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:
- DeviceUseStatement
summary: "POST: /DeviceUseStatement/$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"
/DeviceUseStatement/{id}/$meta:
get:
tags:
- DeviceUseStatement
summary: "GET: /DeviceUseStatement/{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:
- DeviceUseStatement
summary: "POST: /DeviceUseStatement/{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"
/DeviceUseStatement/$expunge:
post:
tags:
- DeviceUseStatement
summary: "POST: /DeviceUseStatement/$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"
/DeviceUseStatement/{id}/$expunge:
post:
tags:
- DeviceUseStatement
summary: "POST: /DeviceUseStatement/{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"
/DeviceUseStatement/{id}/$diff:
get:
tags:
- DeviceUseStatement
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:
- DeviceUseStatement
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}:
get:
tags:
- DiagnosticReport
summary: "read-instance: Read DiagnosticReport instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- DiagnosticReport
summary: "update-instance: Update an existing DiagnosticReport 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": "DiagnosticReport"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- DiagnosticReport
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- DiagnosticReport
summary: "instance-patch: Patch a resource instance of type DiagnosticReport\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/{id}/_history/{version_id}:
get:
tags:
- DiagnosticReport
summary: "vread-instance: Read DiagnosticReport instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport:
get:
tags:
- DiagnosticReport
summary: "search-type: Search for DiagnosticReport instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
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* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
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"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DiagnosticReport
summary: "create-type: Create a new DiagnosticReport instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "DiagnosticReport"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/_history:
get:
tags:
- DiagnosticReport
summary: "type-history: Fetch the resource change history for all resources\
\ of type DiagnosticReport"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/{id}/_history:
get:
tags:
- DiagnosticReport
summary: "instance-history: Fetch the resource change history for all resources\
\ of type DiagnosticReport"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DiagnosticReport/_search:
get:
tags:
- DiagnosticReport
summary: "search-type: Search for DiagnosticReport instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
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* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
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"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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/{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/$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"
/DocumentManifest/{id}:
get:
tags:
- DocumentManifest
summary: "read-instance: Read DocumentManifest instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- DocumentManifest
summary: "update-instance: Update an existing DocumentManifest instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "DocumentManifest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- DocumentManifest
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- DocumentManifest
summary: "instance-patch: Patch a resource instance of type DocumentManifest\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentManifest/{id}/_history/{version_id}:
get:
tags:
- DocumentManifest
summary: "vread-instance: Read DocumentManifest instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentManifest:
get:
tags:
- DocumentManifest
summary: "search-type: Search for DocumentManifest instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: item
in: query
description: Items in manifest
required: false
schema:
type: string
- name: related-id
in: query
description: Identifiers of things that are related
required: false
schema:
type: string
- name: author
in: query
description: Who and/or what authored the DocumentManifest
required: false
schema:
type: string
- name: created
in: query
description: When this document manifest created
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: The subject of the set of documents
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: Human-readable description (title)
required: false
schema:
type: string
- name: source
in: query
description: The source system/application/software
required: false
schema:
type: string
- name: type
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html):\
\ Kind of document set\r\n* [DocumentReference](documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class\
\ - e.g. specialist referral, disease management"
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: related-ref
in: query
description: Related Resource
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: recipient
in: query
description: Intended to get notified about this set of documents
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: 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"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DocumentManifest
summary: "create-type: Create a new DocumentManifest instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "DocumentManifest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentManifest/_history:
get:
tags:
- DocumentManifest
summary: "type-history: Fetch the resource change history for all resources\
\ of type DocumentManifest"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentManifest/{id}/_history:
get:
tags:
- DocumentManifest
summary: "instance-history: Fetch the resource change history for all resources\
\ of type DocumentManifest"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentManifest/_search:
get:
tags:
- DocumentManifest
summary: "search-type: Search for DocumentManifest instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: item
in: query
description: Items in manifest
required: false
schema:
type: string
- name: related-id
in: query
description: Identifiers of things that are related
required: false
schema:
type: string
- name: author
in: query
description: Who and/or what authored the DocumentManifest
required: false
schema:
type: string
- name: created
in: query
description: When this document manifest created
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: The subject of the set of documents
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: Human-readable description (title)
required: false
schema:
type: string
- name: source
in: query
description: The source system/application/software
required: false
schema:
type: string
- name: type
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html):\
\ Kind of document set\r\n* [DocumentReference](documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class\
\ - e.g. specialist referral, disease management"
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: related-ref
in: query
description: Related Resource
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: recipient
in: query
description: Intended to get notified about this set of documents
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: 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"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentManifest/$validate:
get:
tags:
- DocumentManifest
summary: "GET: /DocumentManifest/$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:
- DocumentManifest
summary: "POST: /DocumentManifest/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "DocumentManifest",
"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"
/DocumentManifest/{id}/$validate:
get:
tags:
- DocumentManifest
summary: "GET: /DocumentManifest/{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:
- DocumentManifest
summary: "POST: /DocumentManifest/{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": "DocumentManifest",
"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"
/DocumentManifest/{id}/$meta-delete:
post:
tags:
- DocumentManifest
summary: "POST: /DocumentManifest/{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"
/DocumentManifest/{id}/$meta-add:
post:
tags:
- DocumentManifest
summary: "POST: /DocumentManifest/{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"
/DocumentManifest/$meta:
get:
tags:
- DocumentManifest
summary: "GET: /DocumentManifest/$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:
- DocumentManifest
summary: "POST: /DocumentManifest/$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"
/DocumentManifest/{id}/$meta:
get:
tags:
- DocumentManifest
summary: "GET: /DocumentManifest/{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:
- DocumentManifest
summary: "POST: /DocumentManifest/{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"
/DocumentManifest/$expunge:
post:
tags:
- DocumentManifest
summary: "POST: /DocumentManifest/$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"
/DocumentManifest/{id}/$expunge:
post:
tags:
- DocumentManifest
summary: "POST: /DocumentManifest/{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"
/DocumentManifest/{id}/$diff:
get:
tags:
- DocumentManifest
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:
- DocumentManifest
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}:
get:
tags:
- DocumentReference
summary: "read-instance: Read DocumentReference instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- DocumentReference
summary: "update-instance: Update an existing DocumentReference instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "DocumentReference"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- DocumentReference
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- DocumentReference
summary: "instance-patch: Patch a resource instance of type DocumentReference\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/{id}/_history/{version_id}:
get:
tags:
- DocumentReference
summary: "vread-instance: Read DocumentReference instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference:
get:
tags:
- DocumentReference
summary: "search-type: Search for DocumentReference instances"
description: This is a search type
parameters:
- name: date
in: query
description: When this document reference was created
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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* [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html):\
\ Kind of document set\r\n* [DocumentReference](documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class\
\ - e.g. specialist referral, disease management"
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: related
in: query
description: Related identifiers or resources
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: event
in: query
description: Main clinical acts documented
required: false
schema:
type: string
- name: relationship
in: query
description: Combination of relation and relatesTo
required: false
schema:
type: string
- name: authenticator
in: query
description: Who/what authenticated the document
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
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: 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: format
in: query
description: Format/content rules for the document
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: contenttype
in: query
description: "Mime type of the content, with charset etc."
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: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: Uri where the data can be found
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"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- DocumentReference
summary: "create-type: Create a new DocumentReference instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "DocumentReference"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/_history:
get:
tags:
- DocumentReference
summary: "type-history: Fetch the resource change history for all resources\
\ of type DocumentReference"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/{id}/_history:
get:
tags:
- DocumentReference
summary: "instance-history: Fetch the resource change history for all resources\
\ of type DocumentReference"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/DocumentReference/_search:
get:
tags:
- DocumentReference
summary: "search-type: Search for DocumentReference instances"
description: This is a search type
parameters:
- name: date
in: query
description: When this document reference was created
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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* [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html):\
\ Kind of document set\r\n* [DocumentReference](documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class\
\ - e.g. specialist referral, disease management"
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: related
in: query
description: Related identifiers or resources
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: event
in: query
description: Main clinical acts documented
required: false
schema:
type: string
- name: relationship
in: query
description: Combination of relation and relatesTo
required: false
schema:
type: string
- name: authenticator
in: query
description: Who/what authenticated the document
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
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: 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: format
in: query
description: Format/content rules for the document
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: contenttype
in: query
description: "Mime type of the content, with charset etc."
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: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: Uri where the data can be found
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"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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/{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/$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"
/EffectEvidenceSynthesis/{id}:
get:
tags:
- EffectEvidenceSynthesis
summary: "read-instance: Read EffectEvidenceSynthesis instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- EffectEvidenceSynthesis
summary: "update-instance: Update an existing EffectEvidenceSynthesis 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": "EffectEvidenceSynthesis"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- EffectEvidenceSynthesis
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:
- EffectEvidenceSynthesis
summary: "instance-patch: Patch a resource instance of type EffectEvidenceSynthesis\
\ 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"
/EffectEvidenceSynthesis/{id}/_history/{version_id}:
get:
tags:
- EffectEvidenceSynthesis
summary: "vread-instance: Read EffectEvidenceSynthesis instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EffectEvidenceSynthesis:
get:
tags:
- EffectEvidenceSynthesis
summary: "search-type: Search for EffectEvidenceSynthesis instances"
description: This is a search type
parameters:
- name: date
in: query
description: The effect evidence synthesis publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: A use context type and value assigned to the effect evidence
synthesis
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the effect evidence synthesis
required: false
schema:
type: string
- name: description
in: query
description: The description of the effect evidence synthesis
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the effect evidence synthesis
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the effect evidence synthesis
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: A quantity- or range-valued use context assigned to the effect
evidence synthesis
required: false
schema:
anyOf:
- type: string
- type: number
- name: effective
in: query
description: The time during which the effect evidence synthesis is intended
to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the effect evidence synthesis
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the effect evidence synthesis
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the effect evidence synthesis
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: The business version of the effect evidence synthesis
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the effect evidence synthesis
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: Computationally friendly name of the effect evidence synthesis
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the effect evidence synthesis
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 effect evidence synthesis
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:
- EffectEvidenceSynthesis
summary: "create-type: Create a new EffectEvidenceSynthesis instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "EffectEvidenceSynthesis"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EffectEvidenceSynthesis/_history:
get:
tags:
- EffectEvidenceSynthesis
summary: "type-history: Fetch the resource change history for all resources\
\ of type EffectEvidenceSynthesis"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EffectEvidenceSynthesis/{id}/_history:
get:
tags:
- EffectEvidenceSynthesis
summary: "instance-history: Fetch the resource change history for all resources\
\ of type EffectEvidenceSynthesis"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EffectEvidenceSynthesis/_search:
get:
tags:
- EffectEvidenceSynthesis
summary: "search-type: Search for EffectEvidenceSynthesis instances"
description: This is a search type
parameters:
- name: date
in: query
description: The effect evidence synthesis publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: A use context type and value assigned to the effect evidence
synthesis
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the effect evidence synthesis
required: false
schema:
type: string
- name: description
in: query
description: The description of the effect evidence synthesis
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the effect evidence synthesis
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the effect evidence synthesis
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: A quantity- or range-valued use context assigned to the effect
evidence synthesis
required: false
schema:
anyOf:
- type: string
- type: number
- name: effective
in: query
description: The time during which the effect evidence synthesis is intended
to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the effect evidence synthesis
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the effect evidence synthesis
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the effect evidence synthesis
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: The business version of the effect evidence synthesis
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the effect evidence synthesis
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: Computationally friendly name of the effect evidence synthesis
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the effect evidence synthesis
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 effect evidence synthesis
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"
/EffectEvidenceSynthesis/$validate:
get:
tags:
- EffectEvidenceSynthesis
summary: "GET: /EffectEvidenceSynthesis/$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:
- EffectEvidenceSynthesis
summary: "POST: /EffectEvidenceSynthesis/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "EffectEvidenceSynthesis",
"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"
/EffectEvidenceSynthesis/{id}/$validate:
get:
tags:
- EffectEvidenceSynthesis
summary: "GET: /EffectEvidenceSynthesis/{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:
- EffectEvidenceSynthesis
summary: "POST: /EffectEvidenceSynthesis/{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": "EffectEvidenceSynthesis",
"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"
/EffectEvidenceSynthesis/{id}/$meta-delete:
post:
tags:
- EffectEvidenceSynthesis
summary: "POST: /EffectEvidenceSynthesis/{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"
/EffectEvidenceSynthesis/{id}/$meta-add:
post:
tags:
- EffectEvidenceSynthesis
summary: "POST: /EffectEvidenceSynthesis/{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"
/EffectEvidenceSynthesis/$meta:
get:
tags:
- EffectEvidenceSynthesis
summary: "GET: /EffectEvidenceSynthesis/$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:
- EffectEvidenceSynthesis
summary: "POST: /EffectEvidenceSynthesis/$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"
/EffectEvidenceSynthesis/{id}/$meta:
get:
tags:
- EffectEvidenceSynthesis
summary: "GET: /EffectEvidenceSynthesis/{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:
- EffectEvidenceSynthesis
summary: "POST: /EffectEvidenceSynthesis/{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"
/EffectEvidenceSynthesis/$expunge:
post:
tags:
- EffectEvidenceSynthesis
summary: "POST: /EffectEvidenceSynthesis/$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"
/EffectEvidenceSynthesis/{id}/$expunge:
post:
tags:
- EffectEvidenceSynthesis
summary: "POST: /EffectEvidenceSynthesis/{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"
/EffectEvidenceSynthesis/{id}/$diff:
get:
tags:
- EffectEvidenceSynthesis
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:
- EffectEvidenceSynthesis
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}:
get:
tags:
- Encounter
summary: "read-instance: Read Encounter instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Encounter
summary: "update-instance: Update an existing Encounter instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Encounter"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Encounter
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Encounter
summary: "instance-patch: Patch a resource instance of type Encounter by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/{id}/_history/{version_id}:
get:
tags:
- Encounter
summary: "vread-instance: Read Encounter instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter:
get:
tags:
- Encounter
summary: "search-type: Search for Encounter instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
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
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* [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html):\
\ Kind of document set\r\n* [DocumentReference](documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class\
\ - e.g. specialist referral, disease management"
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: Coded reason the encounter takes place
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: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
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: _security
in: query
description: Security Labels applied to this resource
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: diagnosis
in: query
description: The diagnosis or procedure relevant to the encounter
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: reason-reference
in: query
description: Reason the encounter takes place (reference)
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: 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: _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 | arrived | triaged | in-progress | onleave | finished
| cancelled +
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: "create-type: Create a new Encounter instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Encounter"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/_history:
get:
tags:
- Encounter
summary: "type-history: Fetch the resource change history for all resources\
\ of type Encounter"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/{id}/_history:
get:
tags:
- Encounter
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Encounter"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Encounter/_search:
get:
tags:
- Encounter
summary: "search-type: Search for Encounter instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
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
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* [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html):\
\ Kind of document set\r\n* [DocumentReference](documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class\
\ - e.g. specialist referral, disease management"
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: Coded reason the encounter takes place
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: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
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: _security
in: query
description: Security Labels applied to this resource
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: diagnosis
in: query
description: The diagnosis or procedure relevant to the encounter
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: reason-reference
in: query
description: Reason the encounter takes place (reference)
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: 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: _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 | arrived | triaged | in-progress | onleave | finished
| cancelled +
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"
/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/{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/$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 (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: _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: "Filter the resources to return only resources matching the given\
\ _type filter (note that this filter is applied only to results which link\
\ to the given patient, not to the patient itself or to supporting resources\
\ linked to by the matched resources)"
required: false
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 (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: _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: "Filter the resources to return only resources matching the given\
\ _type filter (note that this filter is applied only to results which link\
\ to the given patient, not to the patient itself or to supporting resources\
\ linked to by the matched resources)"
required: false
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"
/Endpoint/{id}:
get:
tags:
- Endpoint
summary: "read-instance: Read Endpoint instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Endpoint
summary: "update-instance: Update an existing Endpoint instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Endpoint"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Endpoint
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Endpoint
summary: "instance-patch: Patch a resource instance of type Endpoint by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/{id}/_history/{version_id}:
get:
tags:
- Endpoint
summary: "vread-instance: Read Endpoint instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint:
get:
tags:
- Endpoint
summary: "search-type: Search for Endpoint instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Identifies this endpoint across multiple systems
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: _tag
in: query
description: Tags applied to this resource
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: _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"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Endpoint
summary: "create-type: Create a new Endpoint instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Endpoint"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/_history:
get:
tags:
- Endpoint
summary: "type-history: Fetch the resource change history for all resources\
\ of type Endpoint"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/{id}/_history:
get:
tags:
- Endpoint
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Endpoint"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Endpoint/_search:
get:
tags:
- Endpoint
summary: "search-type: Search for Endpoint instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Identifies this endpoint across multiple systems
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: _tag
in: query
description: Tags applied to this resource
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: _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"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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/{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/$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"
/EnrollmentRequest/{id}:
get:
tags:
- EnrollmentRequest
summary: "read-instance: Read EnrollmentRequest instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- EnrollmentRequest
summary: "update-instance: Update an existing EnrollmentRequest instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "EnrollmentRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- EnrollmentRequest
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- EnrollmentRequest
summary: "instance-patch: Patch a resource instance of type EnrollmentRequest\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/{id}/_history/{version_id}:
get:
tags:
- EnrollmentRequest
summary: "vread-instance: Read EnrollmentRequest instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest:
get:
tags:
- EnrollmentRequest
summary: "search-type: Search for EnrollmentRequest instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier of the Enrollment
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: The party to be enrolled
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"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EnrollmentRequest
summary: "create-type: Create a new EnrollmentRequest instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "EnrollmentRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/_history:
get:
tags:
- EnrollmentRequest
summary: "type-history: Fetch the resource change history for all resources\
\ of type EnrollmentRequest"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/{id}/_history:
get:
tags:
- EnrollmentRequest
summary: "instance-history: Fetch the resource change history for all resources\
\ of type EnrollmentRequest"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentRequest/_search:
get:
tags:
- EnrollmentRequest
summary: "search-type: Search for EnrollmentRequest instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier of the Enrollment
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: The party to be enrolled
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"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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/{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/$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"
/EnrollmentResponse/{id}:
get:
tags:
- EnrollmentResponse
summary: "read-instance: Read EnrollmentResponse instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- EnrollmentResponse
summary: "update-instance: Update an existing EnrollmentResponse instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "EnrollmentResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- EnrollmentResponse
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- EnrollmentResponse
summary: "instance-patch: Patch a resource instance of type EnrollmentResponse\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/{id}/_history/{version_id}:
get:
tags:
- EnrollmentResponse
summary: "vread-instance: Read EnrollmentResponse instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse:
get:
tags:
- EnrollmentResponse
summary: "search-type: Search for EnrollmentResponse instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
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: _profile
in: query
description: Profiles this resource claims to conform to
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: _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: _security
in: query
description: Security Labels applied to this resource
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
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
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: "create-type: Create a new EnrollmentResponse instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "EnrollmentResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/_history:
get:
tags:
- EnrollmentResponse
summary: "type-history: Fetch the resource change history for all resources\
\ of type EnrollmentResponse"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/{id}/_history:
get:
tags:
- EnrollmentResponse
summary: "instance-history: Fetch the resource change history for all resources\
\ of type EnrollmentResponse"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EnrollmentResponse/_search:
get:
tags:
- EnrollmentResponse
summary: "search-type: Search for EnrollmentResponse instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
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: _profile
in: query
description: Profiles this resource claims to conform to
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: _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: _security
in: query
description: Security Labels applied to this resource
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
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/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/{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/$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"
/EpisodeOfCare/{id}:
get:
tags:
- EpisodeOfCare
summary: "read-instance: Read EpisodeOfCare instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- EpisodeOfCare
summary: "update-instance: Update an existing EpisodeOfCare instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "EpisodeOfCare"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- EpisodeOfCare
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- EpisodeOfCare
summary: "instance-patch: Patch a resource instance of type EpisodeOfCare by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/{id}/_history/{version_id}:
get:
tags:
- EpisodeOfCare
summary: "vread-instance: Read EpisodeOfCare instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare:
get:
tags:
- EpisodeOfCare
summary: "search-type: Search for EpisodeOfCare instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
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* [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html):\
\ Kind of document set\r\n* [DocumentReference](documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class\
\ - e.g. specialist referral, disease management"
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: condition
in: query
description: Conditions/problems/diagnoses this episode of care is for
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The organization that has assumed the specific responsibilities
of this EpisodeOfCare
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: 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"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- EpisodeOfCare
summary: "create-type: Create a new EpisodeOfCare instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "EpisodeOfCare"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/_history:
get:
tags:
- EpisodeOfCare
summary: "type-history: Fetch the resource change history for all resources\
\ of type EpisodeOfCare"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/{id}/_history:
get:
tags:
- EpisodeOfCare
summary: "instance-history: Fetch the resource change history for all resources\
\ of type EpisodeOfCare"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EpisodeOfCare/_search:
get:
tags:
- EpisodeOfCare
summary: "search-type: Search for EpisodeOfCare instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
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* [AllergyIntolerance](allergyintolerance.html):\
\ allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html):\
\ Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html):\
\ Kind of document set\r\n* [DocumentReference](documentreference.html):\
\ Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html):\
\ Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class\
\ - e.g. specialist referral, disease management"
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: condition
in: query
description: Conditions/problems/diagnoses this episode of care is for
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The organization that has assumed the specific responsibilities
of this EpisodeOfCare
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: 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"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/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/{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/$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"
/EventDefinition/{id}:
get:
tags:
- EventDefinition
summary: "read-instance: Read EventDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- EventDefinition
summary: "update-instance: Update an existing EventDefinition instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "EventDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- EventDefinition
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- EventDefinition
summary: "instance-patch: Patch a resource instance of type EventDefinition\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/{id}/_history/{version_id}:
get:
tags:
- EventDefinition
summary: "vread-instance: Read EventDefinition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition:
get:
tags:
- EventDefinition
summary: "search-type: Search for EventDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The event definition publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the event definition
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the event definition
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the event definition
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the event definition
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the event definition
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: A quantity- or range-valued use context assigned to the event
definition
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the event definition is intended to be
in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the event definition
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the event definition
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the event definition
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: The business version of the event definition
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the event definition
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: Computationally friendly name of the event definition
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the event definition
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the module
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 event definition
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: "create-type: Create a new EventDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "EventDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/_history:
get:
tags:
- EventDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type EventDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/{id}/_history:
get:
tags:
- EventDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type EventDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EventDefinition/_search:
get:
tags:
- EventDefinition
summary: "search-type: Search for EventDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The event definition publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the event definition
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the event definition
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the event definition
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the event definition
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the event definition
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: A quantity- or range-valued use context assigned to the event
definition
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the event definition is intended to be
in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the event definition
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the event definition
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the event definition
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: The business version of the event definition
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the event definition
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: Computationally friendly name of the event definition
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the event definition
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the module
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 event definition
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"
/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/{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/$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"
/Evidence/{id}:
get:
tags:
- Evidence
summary: "read-instance: Read Evidence instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Evidence
summary: "update-instance: Update an existing Evidence instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Evidence"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Evidence
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Evidence
summary: "instance-patch: Patch a resource instance of type Evidence by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/{id}/_history/{version_id}:
get:
tags:
- Evidence
summary: "vread-instance: Read Evidence instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence:
get:
tags:
- Evidence
summary: "search-type: Search for Evidence instances"
description: This is a search type
parameters:
- name: date
in: query
description: The evidence publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the evidence
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the evidence
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the evidence
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the evidence
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the evidence
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: A quantity- or range-valued use context assigned to the evidence
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the evidence is intended to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the evidence
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the evidence
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the evidence
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: The business version of the evidence
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the evidence
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: Computationally friendly name of the evidence
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the evidence
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the Evidence
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 evidence
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: "create-type: Create a new Evidence instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Evidence"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/_history:
get:
tags:
- Evidence
summary: "type-history: Fetch the resource change history for all resources\
\ of type Evidence"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/{id}/_history:
get:
tags:
- Evidence
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Evidence"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Evidence/_search:
get:
tags:
- Evidence
summary: "search-type: Search for Evidence instances"
description: This is a search type
parameters:
- name: date
in: query
description: The evidence publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the evidence
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the evidence
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the evidence
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the evidence
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the evidence
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: A quantity- or range-valued use context assigned to the evidence
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the evidence is intended to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the evidence
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the evidence
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the evidence
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: The business version of the evidence
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the evidence
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: Computationally friendly name of the evidence
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the evidence
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the Evidence
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 evidence
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"
/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/{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/$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"
/EvidenceVariable/{id}:
get:
tags:
- EvidenceVariable
summary: "read-instance: Read EvidenceVariable instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- EvidenceVariable
summary: "update-instance: Update an existing EvidenceVariable instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "EvidenceVariable"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- EvidenceVariable
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- EvidenceVariable
summary: "instance-patch: Patch a resource instance of type EvidenceVariable\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/{id}/_history/{version_id}:
get:
tags:
- EvidenceVariable
summary: "vread-instance: Read EvidenceVariable instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable:
get:
tags:
- EvidenceVariable
summary: "search-type: Search for EvidenceVariable instances"
description: This is a search type
parameters:
- name: date
in: query
description: The evidence variable publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the evidence variable
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the evidence variable
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the evidence variable
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the evidence variable
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the evidence variable
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: A quantity- or range-valued use context assigned to the evidence
variable
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the evidence variable is intended to be
in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the evidence variable
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the evidence variable
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the evidence variable
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: The business version of the evidence variable
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the evidence variable
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: Computationally friendly name of the evidence variable
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the evidence variable
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the EvidenceVariable
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 evidence variable
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: "create-type: Create a new EvidenceVariable instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "EvidenceVariable"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/_history:
get:
tags:
- EvidenceVariable
summary: "type-history: Fetch the resource change history for all resources\
\ of type EvidenceVariable"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/{id}/_history:
get:
tags:
- EvidenceVariable
summary: "instance-history: Fetch the resource change history for all resources\
\ of type EvidenceVariable"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/EvidenceVariable/_search:
get:
tags:
- EvidenceVariable
summary: "search-type: Search for EvidenceVariable instances"
description: This is a search type
parameters:
- name: date
in: query
description: The evidence variable publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the evidence variable
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the evidence variable
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the evidence variable
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the evidence variable
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the evidence variable
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: A quantity- or range-valued use context assigned to the evidence
variable
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the evidence variable is intended to be
in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the evidence variable
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the evidence variable
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the evidence variable
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: The business version of the evidence variable
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the evidence variable
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: Computationally friendly name of the evidence variable
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the evidence variable
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the EvidenceVariable
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 evidence variable
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"
/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/{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/$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
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:
- 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"
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"
/ExampleScenario/{id}:
get:
tags:
- ExampleScenario
summary: "read-instance: Read ExampleScenario instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ExampleScenario
summary: "update-instance: Update an existing ExampleScenario instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ExampleScenario"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- ExampleScenario
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- ExampleScenario
summary: "instance-patch: Patch a resource instance of type ExampleScenario\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ExampleScenario/{id}/_history/{version_id}:
get:
tags:
- ExampleScenario
summary: "vread-instance: Read ExampleScenario instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ExampleScenario:
get:
tags:
- ExampleScenario
summary: "search-type: Search for ExampleScenario instances"
description: This is a search type
parameters:
- name: date
in: query
description: The example scenario publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: External identifier for the example scenario
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the example scenario
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the example scenario
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the example scenario
required: false
schema:
type: string
- name: version
in: query
description: The business version of the example scenario
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the example scenario
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: A quantity- or range-valued use context assigned to the example
scenario
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: A use context assigned to the example scenario
required: false
schema:
type: string
- name: name
in: query
description: Computationally friendly name of the example scenario
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the example scenario
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: A use context type and quantity- or range-based value assigned
to the example scenario
required: false
schema:
type: string
- name: status
in: query
description: The current status of the example scenario
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:
- ExampleScenario
summary: "create-type: Create a new ExampleScenario instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ExampleScenario"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ExampleScenario/_history:
get:
tags:
- ExampleScenario
summary: "type-history: Fetch the resource change history for all resources\
\ of type ExampleScenario"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ExampleScenario/{id}/_history:
get:
tags:
- ExampleScenario
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ExampleScenario"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ExampleScenario/_search:
get:
tags:
- ExampleScenario
summary: "search-type: Search for ExampleScenario instances"
description: This is a search type
parameters:
- name: date
in: query
description: The example scenario publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: External identifier for the example scenario
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the example scenario
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the example scenario
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the example scenario
required: false
schema:
type: string
- name: version
in: query
description: The business version of the example scenario
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the example scenario
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: A quantity- or range-valued use context assigned to the example
scenario
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: A use context assigned to the example scenario
required: false
schema:
type: string
- name: name
in: query
description: Computationally friendly name of the example scenario
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the example scenario
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: A use context type and quantity- or range-based value assigned
to the example scenario
required: false
schema:
type: string
- name: status
in: query
description: The current status of the example scenario
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"
/ExampleScenario/$validate:
get:
tags:
- ExampleScenario
summary: "GET: /ExampleScenario/$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:
- ExampleScenario
summary: "POST: /ExampleScenario/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ExampleScenario",
"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"
/ExampleScenario/{id}/$validate:
get:
tags:
- ExampleScenario
summary: "GET: /ExampleScenario/{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:
- ExampleScenario
summary: "POST: /ExampleScenario/{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": "ExampleScenario",
"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"
/ExampleScenario/{id}/$meta-delete:
post:
tags:
- ExampleScenario
summary: "POST: /ExampleScenario/{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"
/ExampleScenario/{id}/$meta-add:
post:
tags:
- ExampleScenario
summary: "POST: /ExampleScenario/{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"
/ExampleScenario/$meta:
get:
tags:
- ExampleScenario
summary: "GET: /ExampleScenario/$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:
- ExampleScenario
summary: "POST: /ExampleScenario/$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"
/ExampleScenario/{id}/$meta:
get:
tags:
- ExampleScenario
summary: "GET: /ExampleScenario/{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:
- ExampleScenario
summary: "POST: /ExampleScenario/{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"
/ExampleScenario/$expunge:
post:
tags:
- ExampleScenario
summary: "POST: /ExampleScenario/$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"
/ExampleScenario/{id}/$expunge:
post:
tags:
- ExampleScenario
summary: "POST: /ExampleScenario/{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"
/ExampleScenario/{id}/$diff:
get:
tags:
- ExampleScenario
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:
- ExampleScenario
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"
/ExplanationOfBenefit/{id}:
get:
tags:
- ExplanationOfBenefit
summary: "read-instance: Read ExplanationOfBenefit instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ExplanationOfBenefit
summary: "update-instance: Update an existing ExplanationOfBenefit instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ExplanationOfBenefit"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- ExplanationOfBenefit
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- ExplanationOfBenefit
summary: "instance-patch: Patch a resource instance of type ExplanationOfBenefit\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ExplanationOfBenefit/{id}/_history/{version_id}:
get:
tags:
- ExplanationOfBenefit
summary: "vread-instance: Read ExplanationOfBenefit instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ExplanationOfBenefit:
get:
tags:
- ExplanationOfBenefit
summary: "search-type: Search for ExplanationOfBenefit instances"
description: This is a search type
parameters:
- name: care-team
in: query
description: Member of the CareTeam
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: payee
in: query
description: The party receiving any payment for the Claim
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: provider
in: query
description: The reference to the provider
required: false
schema:
type: string
- name: patient
in: query
description: The reference to the patient
required: false
schema:
type: string
- name: detail-udi
in: query
description: UDI associated with a line item detail product or service
required: false
schema:
type: string
- name: claim
in: query
description: The reference to the claim
required: false
schema:
type: string
- name: enterer
in: query
description: The party responsible for the entry of the Claim
required: false
schema:
type: string
- name: procedure-udi
in: query
description: UDI associated with a procedure
required: false
schema:
type: string
- name: item-udi
in: query
description: UDI associated with a line item product or service
required: false
schema:
type: string
- name: coverage
in: query
description: The plan under which the claim was adjudicated
required: false
schema:
type: string
- name: identifier
in: query
description: The business identifier of the Explanation of Benefit
required: false
schema:
type: string
- name: created
in: query
description: The creation date for the EOB
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: Encounters associated with a billed line item
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: disposition
in: query
description: The contents of the disposition message
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: subdetail-udi
in: query
description: UDI associated with a line item detail subdetail product or service
required: false
schema:
type: string
- name: facility
in: query
description: Facility responsible for the goods and services
required: false
schema:
type: string
- name: status
in: query
description: Status of the instance
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:
- ExplanationOfBenefit
summary: "create-type: Create a new ExplanationOfBenefit instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ExplanationOfBenefit"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ExplanationOfBenefit/_history:
get:
tags:
- ExplanationOfBenefit
summary: "type-history: Fetch the resource change history for all resources\
\ of type ExplanationOfBenefit"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ExplanationOfBenefit/{id}/_history:
get:
tags:
- ExplanationOfBenefit
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ExplanationOfBenefit"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ExplanationOfBenefit/_search:
get:
tags:
- ExplanationOfBenefit
summary: "search-type: Search for ExplanationOfBenefit instances"
description: This is a search type
parameters:
- name: care-team
in: query
description: Member of the CareTeam
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: payee
in: query
description: The party receiving any payment for the Claim
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: provider
in: query
description: The reference to the provider
required: false
schema:
type: string
- name: patient
in: query
description: The reference to the patient
required: false
schema:
type: string
- name: detail-udi
in: query
description: UDI associated with a line item detail product or service
required: false
schema:
type: string
- name: claim
in: query
description: The reference to the claim
required: false
schema:
type: string
- name: enterer
in: query
description: The party responsible for the entry of the Claim
required: false
schema:
type: string
- name: procedure-udi
in: query
description: UDI associated with a procedure
required: false
schema:
type: string
- name: item-udi
in: query
description: UDI associated with a line item product or service
required: false
schema:
type: string
- name: coverage
in: query
description: The plan under which the claim was adjudicated
required: false
schema:
type: string
- name: identifier
in: query
description: The business identifier of the Explanation of Benefit
required: false
schema:
type: string
- name: created
in: query
description: The creation date for the EOB
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: Encounters associated with a billed line item
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: disposition
in: query
description: The contents of the disposition message
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: subdetail-udi
in: query
description: UDI associated with a line item detail subdetail product or service
required: false
schema:
type: string
- name: facility
in: query
description: Facility responsible for the goods and services
required: false
schema:
type: string
- name: status
in: query
description: Status of the instance
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"
/ExplanationOfBenefit/$validate:
get:
tags:
- ExplanationOfBenefit
summary: "GET: /ExplanationOfBenefit/$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:
- ExplanationOfBenefit
summary: "POST: /ExplanationOfBenefit/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ExplanationOfBenefit",
"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"
/ExplanationOfBenefit/{id}/$validate:
get:
tags:
- ExplanationOfBenefit
summary: "GET: /ExplanationOfBenefit/{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:
- ExplanationOfBenefit
summary: "POST: /ExplanationOfBenefit/{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": "ExplanationOfBenefit",
"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"
/ExplanationOfBenefit/{id}/$meta-delete:
post:
tags:
- ExplanationOfBenefit
summary: "POST: /ExplanationOfBenefit/{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"
/ExplanationOfBenefit/{id}/$meta-add:
post:
tags:
- ExplanationOfBenefit
summary: "POST: /ExplanationOfBenefit/{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"
/ExplanationOfBenefit/$meta:
get:
tags:
- ExplanationOfBenefit
summary: "GET: /ExplanationOfBenefit/$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:
- ExplanationOfBenefit
summary: "POST: /ExplanationOfBenefit/$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"
/ExplanationOfBenefit/{id}/$meta:
get:
tags:
- ExplanationOfBenefit
summary: "GET: /ExplanationOfBenefit/{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:
- ExplanationOfBenefit
summary: "POST: /ExplanationOfBenefit/{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"
/ExplanationOfBenefit/$expunge:
post:
tags:
- ExplanationOfBenefit
summary: "POST: /ExplanationOfBenefit/$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"
/ExplanationOfBenefit/{id}/$expunge:
post:
tags:
- ExplanationOfBenefit
summary: "POST: /ExplanationOfBenefit/{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"
/ExplanationOfBenefit/{id}/$diff:
get:
tags:
- ExplanationOfBenefit
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:
- ExplanationOfBenefit
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"
/FamilyMemberHistory/{id}:
get:
tags:
- FamilyMemberHistory
summary: "read-instance: Read FamilyMemberHistory instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- FamilyMemberHistory
summary: "update-instance: Update an existing FamilyMemberHistory instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "FamilyMemberHistory"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- FamilyMemberHistory
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- FamilyMemberHistory
summary: "instance-patch: Patch a resource instance of type FamilyMemberHistory\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/FamilyMemberHistory/{id}/_history/{version_id}:
get:
tags:
- FamilyMemberHistory
summary: "vread-instance: Read FamilyMemberHistory instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/FamilyMemberHistory:
get:
tags:
- FamilyMemberHistory
summary: "search-type: Search for FamilyMemberHistory instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
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: sex
in: query
description: A search by a sex code of a family member
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: instantiates-uri
in: query
description: Instantiates external protocol or definition
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: relationship
in: query
description: A search by a relationship type
required: false
schema:
type: string
- name: status
in: query
description: partial | completed | entered-in-error | health-unknown
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:
- FamilyMemberHistory
summary: "create-type: Create a new FamilyMemberHistory instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "FamilyMemberHistory"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/FamilyMemberHistory/_history:
get:
tags:
- FamilyMemberHistory
summary: "type-history: Fetch the resource change history for all resources\
\ of type FamilyMemberHistory"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/FamilyMemberHistory/{id}/_history:
get:
tags:
- FamilyMemberHistory
summary: "instance-history: Fetch the resource change history for all resources\
\ of type FamilyMemberHistory"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/FamilyMemberHistory/_search:
get:
tags:
- FamilyMemberHistory
summary: "search-type: Search for FamilyMemberHistory instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
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: sex
in: query
description: A search by a sex code of a family member
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: instantiates-uri
in: query
description: Instantiates external protocol or definition
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: relationship
in: query
description: A search by a relationship type
required: false
schema:
type: string
- name: status
in: query
description: partial | completed | entered-in-error | health-unknown
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"
/FamilyMemberHistory/$validate:
get:
tags:
- FamilyMemberHistory
summary: "GET: /FamilyMemberHistory/$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:
- FamilyMemberHistory
summary: "POST: /FamilyMemberHistory/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "FamilyMemberHistory",
"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"
/FamilyMemberHistory/{id}/$validate:
get:
tags:
- FamilyMemberHistory
summary: "GET: /FamilyMemberHistory/{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:
- FamilyMemberHistory
summary: "POST: /FamilyMemberHistory/{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": "FamilyMemberHistory",
"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"
/FamilyMemberHistory/{id}/$meta-delete:
post:
tags:
- FamilyMemberHistory
summary: "POST: /FamilyMemberHistory/{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"
/FamilyMemberHistory/{id}/$meta-add:
post:
tags:
- FamilyMemberHistory
summary: "POST: /FamilyMemberHistory/{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"
/FamilyMemberHistory/$meta:
get:
tags:
- FamilyMemberHistory
summary: "GET: /FamilyMemberHistory/$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:
- FamilyMemberHistory
summary: "POST: /FamilyMemberHistory/$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"
/FamilyMemberHistory/{id}/$meta:
get:
tags:
- FamilyMemberHistory
summary: "GET: /FamilyMemberHistory/{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:
- FamilyMemberHistory
summary: "POST: /FamilyMemberHistory/{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"
/FamilyMemberHistory/$expunge:
post:
tags:
- FamilyMemberHistory
summary: "POST: /FamilyMemberHistory/$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"
/FamilyMemberHistory/{id}/$expunge:
post:
tags:
- FamilyMemberHistory
summary: "POST: /FamilyMemberHistory/{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"
/FamilyMemberHistory/{id}/$diff:
get:
tags:
- FamilyMemberHistory
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:
- FamilyMemberHistory
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"
/Flag/{id}:
get:
tags:
- Flag
summary: "read-instance: Read Flag instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Flag
summary: "update-instance: Update an existing Flag instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Flag"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Flag
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Flag
summary: "instance-patch: Patch a resource instance of type Flag by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Flag/{id}/_history/{version_id}:
get:
tags:
- Flag
summary: "vread-instance: Read Flag instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Flag:
get:
tags:
- Flag
summary: "search-type: Search for Flag instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: Business identifier
required: false
schema:
type: string
- name: author
in: query
description: Flag creator
required: false
schema:
type: string
- name: subject
in: query
description: The identity of a subject to list flags for
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* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Flag
summary: "create-type: Create a new Flag instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Flag"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Flag/_history:
get:
tags:
- Flag
summary: "type-history: Fetch the resource change history for all resources\
\ of type Flag"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Flag/{id}/_history:
get:
tags:
- Flag
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Flag"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Flag/_search:
get:
tags:
- Flag
summary: "search-type: Search for Flag instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: Business identifier
required: false
schema:
type: string
- name: author
in: query
description: Flag creator
required: false
schema:
type: string
- name: subject
in: query
description: The identity of a subject to list flags for
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* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Flag/$validate:
get:
tags:
- Flag
summary: "GET: /Flag/$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:
- Flag
summary: "POST: /Flag/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Flag",
"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"
/Flag/{id}/$validate:
get:
tags:
- Flag
summary: "GET: /Flag/{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:
- Flag
summary: "POST: /Flag/{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": "Flag",
"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"
/Flag/{id}/$meta-delete:
post:
tags:
- Flag
summary: "POST: /Flag/{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"
/Flag/{id}/$meta-add:
post:
tags:
- Flag
summary: "POST: /Flag/{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"
/Flag/$meta:
get:
tags:
- Flag
summary: "GET: /Flag/$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:
- Flag
summary: "POST: /Flag/$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"
/Flag/{id}/$meta:
get:
tags:
- Flag
summary: "GET: /Flag/{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:
- Flag
summary: "POST: /Flag/{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"
/Flag/$expunge:
post:
tags:
- Flag
summary: "POST: /Flag/$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"
/Flag/{id}/$expunge:
post:
tags:
- Flag
summary: "POST: /Flag/{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"
/Flag/{id}/$diff:
get:
tags:
- Flag
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:
- Flag
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"
/Goal/{id}:
get:
tags:
- Goal
summary: "read-instance: Read Goal instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Goal
summary: "update-instance: Update an existing Goal instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Goal"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Goal
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Goal
summary: "instance-patch: Patch a resource instance of type Goal by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Goal/{id}/_history/{version_id}:
get:
tags:
- Goal
summary: "vread-instance: Read Goal instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Goal:
get:
tags:
- Goal
summary: "search-type: Search for Goal instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: subject
in: query
description: Who this goal is intended for
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: start-date
in: query
description: When goal pursuit begins
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: lifecycle-status
in: query
description: proposed | planned | accepted | active | on-hold | completed
| cancelled | entered-in-error | rejected
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: achievement-status
in: query
description: in-progress | improving | worsening | no-change | achieved |
sustaining | not-achieved | no-progress | not-attainable
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: "E.g. Treatment, dietary, behavioral, etc."
required: false
schema:
type: string
- name: target-date
in: query
description: Reach goal on or before
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Goal
summary: "create-type: Create a new Goal instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Goal"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Goal/_history:
get:
tags:
- Goal
summary: "type-history: Fetch the resource change history for all resources\
\ of type Goal"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Goal/{id}/_history:
get:
tags:
- Goal
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Goal"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Goal/_search:
get:
tags:
- Goal
summary: "search-type: Search for Goal instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: subject
in: query
description: Who this goal is intended for
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: start-date
in: query
description: When goal pursuit begins
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: lifecycle-status
in: query
description: proposed | planned | accepted | active | on-hold | completed
| cancelled | entered-in-error | rejected
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: achievement-status
in: query
description: in-progress | improving | worsening | no-change | achieved |
sustaining | not-achieved | no-progress | not-attainable
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: "E.g. Treatment, dietary, behavioral, etc."
required: false
schema:
type: string
- name: target-date
in: query
description: Reach goal on or before
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Goal/$validate:
get:
tags:
- Goal
summary: "GET: /Goal/$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:
- Goal
summary: "POST: /Goal/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Goal",
"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"
/Goal/{id}/$validate:
get:
tags:
- Goal
summary: "GET: /Goal/{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:
- Goal
summary: "POST: /Goal/{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": "Goal",
"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"
/Goal/{id}/$meta-delete:
post:
tags:
- Goal
summary: "POST: /Goal/{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"
/Goal/{id}/$meta-add:
post:
tags:
- Goal
summary: "POST: /Goal/{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"
/Goal/$meta:
get:
tags:
- Goal
summary: "GET: /Goal/$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:
- Goal
summary: "POST: /Goal/$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"
/Goal/{id}/$meta:
get:
tags:
- Goal
summary: "GET: /Goal/{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:
- Goal
summary: "POST: /Goal/{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"
/Goal/$expunge:
post:
tags:
- Goal
summary: "POST: /Goal/$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"
/Goal/{id}/$expunge:
post:
tags:
- Goal
summary: "POST: /Goal/{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"
/Goal/{id}/$diff:
get:
tags:
- Goal
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:
- Goal
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"
/GraphDefinition/{id}:
get:
tags:
- GraphDefinition
summary: "read-instance: Read GraphDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- GraphDefinition
summary: "update-instance: Update an existing GraphDefinition instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "GraphDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- GraphDefinition
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- GraphDefinition
summary: "instance-patch: Patch a resource instance of type GraphDefinition\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/GraphDefinition/{id}/_history/{version_id}:
get:
tags:
- GraphDefinition
summary: "vread-instance: Read GraphDefinition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/GraphDefinition:
get:
tags:
- GraphDefinition
summary: "search-type: Search for GraphDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: start
in: query
description: Type of resource at which the graph starts
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- GraphDefinition
summary: "create-type: Create a new GraphDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "GraphDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/GraphDefinition/_history:
get:
tags:
- GraphDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type GraphDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/GraphDefinition/{id}/_history:
get:
tags:
- GraphDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type GraphDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/GraphDefinition/_search:
get:
tags:
- GraphDefinition
summary: "search-type: Search for GraphDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: start
in: query
description: Type of resource at which the graph starts
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/GraphDefinition/$validate:
get:
tags:
- GraphDefinition
summary: "GET: /GraphDefinition/$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:
- GraphDefinition
summary: "POST: /GraphDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "GraphDefinition",
"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"
/GraphDefinition/{id}/$validate:
get:
tags:
- GraphDefinition
summary: "GET: /GraphDefinition/{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:
- GraphDefinition
summary: "POST: /GraphDefinition/{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": "GraphDefinition",
"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"
/GraphDefinition/{id}/$meta-delete:
post:
tags:
- GraphDefinition
summary: "POST: /GraphDefinition/{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"
/GraphDefinition/{id}/$meta-add:
post:
tags:
- GraphDefinition
summary: "POST: /GraphDefinition/{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"
/GraphDefinition/$meta:
get:
tags:
- GraphDefinition
summary: "GET: /GraphDefinition/$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:
- GraphDefinition
summary: "POST: /GraphDefinition/$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"
/GraphDefinition/{id}/$meta:
get:
tags:
- GraphDefinition
summary: "GET: /GraphDefinition/{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:
- GraphDefinition
summary: "POST: /GraphDefinition/{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"
/GraphDefinition/$expunge:
post:
tags:
- GraphDefinition
summary: "POST: /GraphDefinition/$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"
/GraphDefinition/{id}/$expunge:
post:
tags:
- GraphDefinition
summary: "POST: /GraphDefinition/{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"
/GraphDefinition/{id}/$diff:
get:
tags:
- GraphDefinition
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:
- GraphDefinition
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Group/{id}:
get:
tags:
- Group
summary: "read-instance: Read Group instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Group
summary: "update-instance: Update an existing Group instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Group"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Group
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Group
summary: "instance-patch: Patch a resource instance of type Group by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Group/{id}/_history/{version_id}:
get:
tags:
- Group
summary: "vread-instance: Read Group instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Group:
get:
tags:
- Group
summary: "search-type: Search for Group instances"
description: This is a search type
parameters:
- name: actual
in: query
description: Descriptive or actual
required: false
schema:
type: string
- name: identifier
in: query
description: Unique id
required: false
schema:
type: string
- name: managing-entity
in: query
description: Entity that is the custodian of the Group's definition
required: false
schema:
type: string
- name: code
in: query
description: The kind of resources contained
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: The type of resources the group contains
required: false
schema:
type: string
- name: characteristic
in: query
description: Kind of characteristic
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: characteristic-value
in: query
description: A composite of both characteristic and value
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: member
in: query
description: Reference to the group member
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: exclude
in: query
description: Group includes or excludes
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: value
in: query
description: Value held by characteristic
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Group
summary: "create-type: Create a new Group instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Group"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Group/_history:
get:
tags:
- Group
summary: "type-history: Fetch the resource change history for all resources\
\ of type Group"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Group/{id}/_history:
get:
tags:
- Group
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Group"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Group/_search:
get:
tags:
- Group
summary: "search-type: Search for Group instances"
description: This is a search type
parameters:
- name: actual
in: query
description: Descriptive or actual
required: false
schema:
type: string
- name: identifier
in: query
description: Unique id
required: false
schema:
type: string
- name: managing-entity
in: query
description: Entity that is the custodian of the Group's definition
required: false
schema:
type: string
- name: code
in: query
description: The kind of resources contained
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: The type of resources the group contains
required: false
schema:
type: string
- name: characteristic
in: query
description: Kind of characteristic
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: characteristic-value
in: query
description: A composite of both characteristic and value
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: member
in: query
description: Reference to the group member
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: exclude
in: query
description: Group includes or excludes
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: value
in: query
description: Value held by characteristic
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"
/Group/$validate:
get:
tags:
- Group
summary: "GET: /Group/$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:
- Group
summary: "POST: /Group/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Group",
"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"
/Group/{id}/$validate:
get:
tags:
- Group
summary: "GET: /Group/{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:
- Group
summary: "POST: /Group/{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": "Group",
"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"
/Group/{id}/$meta-delete:
post:
tags:
- Group
summary: "POST: /Group/{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"
/Group/{id}/$meta-add:
post:
tags:
- Group
summary: "POST: /Group/{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"
/Group/$meta:
get:
tags:
- Group
summary: "GET: /Group/$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:
- Group
summary: "POST: /Group/$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"
/Group/{id}/$meta:
get:
tags:
- Group
summary: "GET: /Group/{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:
- Group
summary: "POST: /Group/{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"
/Group/$expunge:
post:
tags:
- Group
summary: "POST: /Group/$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"
/Group/{id}/$expunge:
post:
tags:
- Group
summary: "POST: /Group/{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"
/Group/{id}/$diff:
get:
tags:
- Group
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Group
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/GuidanceResponse/{id}:
get:
tags:
- GuidanceResponse
summary: "read-instance: Read GuidanceResponse instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- GuidanceResponse
summary: "update-instance: Update an existing GuidanceResponse instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "GuidanceResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- GuidanceResponse
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- GuidanceResponse
summary: "instance-patch: Patch a resource instance of type GuidanceResponse\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/GuidanceResponse/{id}/_history/{version_id}:
get:
tags:
- GuidanceResponse
summary: "vread-instance: Read GuidanceResponse instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/GuidanceResponse:
get:
tags:
- GuidanceResponse
summary: "search-type: Search for GuidanceResponse instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The identifier of the guidance response
required: false
schema:
type: string
- name: request
in: query
description: The identifier of the request associated with the response
required: false
schema:
type: string
- name: subject
in: query
description: The subject that the guidance response is about
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: The identity of a patient to search for guidance response results
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- GuidanceResponse
summary: "create-type: Create a new GuidanceResponse instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "GuidanceResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/GuidanceResponse/_history:
get:
tags:
- GuidanceResponse
summary: "type-history: Fetch the resource change history for all resources\
\ of type GuidanceResponse"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/GuidanceResponse/{id}/_history:
get:
tags:
- GuidanceResponse
summary: "instance-history: Fetch the resource change history for all resources\
\ of type GuidanceResponse"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/GuidanceResponse/_search:
get:
tags:
- GuidanceResponse
summary: "search-type: Search for GuidanceResponse instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The identifier of the guidance response
required: false
schema:
type: string
- name: request
in: query
description: The identifier of the request associated with the response
required: false
schema:
type: string
- name: subject
in: query
description: The subject that the guidance response is about
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: The identity of a patient to search for guidance response results
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/GuidanceResponse/$validate:
get:
tags:
- GuidanceResponse
summary: "GET: /GuidanceResponse/$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:
- GuidanceResponse
summary: "POST: /GuidanceResponse/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "GuidanceResponse",
"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"
/GuidanceResponse/{id}/$validate:
get:
tags:
- GuidanceResponse
summary: "GET: /GuidanceResponse/{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:
- GuidanceResponse
summary: "POST: /GuidanceResponse/{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": "GuidanceResponse",
"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"
/GuidanceResponse/{id}/$meta-delete:
post:
tags:
- GuidanceResponse
summary: "POST: /GuidanceResponse/{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"
/GuidanceResponse/{id}/$meta-add:
post:
tags:
- GuidanceResponse
summary: "POST: /GuidanceResponse/{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"
/GuidanceResponse/$meta:
get:
tags:
- GuidanceResponse
summary: "GET: /GuidanceResponse/$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:
- GuidanceResponse
summary: "POST: /GuidanceResponse/$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"
/GuidanceResponse/{id}/$meta:
get:
tags:
- GuidanceResponse
summary: "GET: /GuidanceResponse/{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:
- GuidanceResponse
summary: "POST: /GuidanceResponse/{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"
/GuidanceResponse/$expunge:
post:
tags:
- GuidanceResponse
summary: "POST: /GuidanceResponse/$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"
/GuidanceResponse/{id}/$expunge:
post:
tags:
- GuidanceResponse
summary: "POST: /GuidanceResponse/{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"
/GuidanceResponse/{id}/$diff:
get:
tags:
- GuidanceResponse
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:
- GuidanceResponse
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"
/HealthcareService/{id}:
get:
tags:
- HealthcareService
summary: "read-instance: Read HealthcareService instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- HealthcareService
summary: "update-instance: Update an existing HealthcareService instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "HealthcareService"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- HealthcareService
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- HealthcareService
summary: "instance-patch: Patch a resource instance of type HealthcareService\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService/{id}/_history/{version_id}:
get:
tags:
- HealthcareService
summary: "vread-instance: Read HealthcareService instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService:
get:
tags:
- HealthcareService
summary: "search-type: Search for HealthcareService instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: External identifiers for this item
required: false
schema:
type: string
- name: specialty
in: query
description: The specialty of the service provided by this healthcare service
required: false
schema:
type: string
- name: service-category
in: query
description: Service Category of the Healthcare Service
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: service-type
in: query
description: The type of service provided by this healthcare service
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: The Healthcare Service is currently marked as active
required: false
schema:
type: string
- name: program
in: query
description: One of the Programs supported by this HealthcareService
required: false
schema:
type: string
- name: characteristic
in: query
description: One of the HealthcareService's characteristics
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to electronic services operated
for the healthcare service
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: coverage-area
in: query
description: Location(s) service is intended for/available to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The organization that provides this Healthcare Service
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: A portion of the Healthcare service name
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: The location of the Healthcare Service
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- HealthcareService
summary: "create-type: Create a new HealthcareService instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "HealthcareService"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService/_history:
get:
tags:
- HealthcareService
summary: "type-history: Fetch the resource change history for all resources\
\ of type HealthcareService"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService/{id}/_history:
get:
tags:
- HealthcareService
summary: "instance-history: Fetch the resource change history for all resources\
\ of type HealthcareService"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService/_search:
get:
tags:
- HealthcareService
summary: "search-type: Search for HealthcareService instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: External identifiers for this item
required: false
schema:
type: string
- name: specialty
in: query
description: The specialty of the service provided by this healthcare service
required: false
schema:
type: string
- name: service-category
in: query
description: Service Category of the Healthcare Service
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: service-type
in: query
description: The type of service provided by this healthcare service
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: The Healthcare Service is currently marked as active
required: false
schema:
type: string
- name: program
in: query
description: One of the Programs supported by this HealthcareService
required: false
schema:
type: string
- name: characteristic
in: query
description: One of the HealthcareService's characteristics
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to electronic services operated
for the healthcare service
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: coverage-area
in: query
description: Location(s) service is intended for/available to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The organization that provides this Healthcare Service
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: A portion of the Healthcare service name
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: The location of the Healthcare Service
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService/$validate:
get:
tags:
- HealthcareService
summary: "GET: /HealthcareService/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "HealthcareService",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService/{id}/$validate:
get:
tags:
- HealthcareService
summary: "GET: /HealthcareService/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "HealthcareService",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService/{id}/$meta-delete:
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService/{id}/$meta-add:
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService/$meta:
get:
tags:
- HealthcareService
summary: "GET: /HealthcareService/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService/{id}/$meta:
get:
tags:
- HealthcareService
summary: "GET: /HealthcareService/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService/$expunge:
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService/{id}/$expunge:
post:
tags:
- HealthcareService
summary: "POST: /HealthcareService/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/HealthcareService/{id}/$diff:
get:
tags:
- HealthcareService
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:
- HealthcareService
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"
/ImagingStudy/{id}:
get:
tags:
- ImagingStudy
summary: "read-instance: Read ImagingStudy instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ImagingStudy
summary: "update-instance: Update an existing ImagingStudy instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ImagingStudy"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- ImagingStudy
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- ImagingStudy
summary: "instance-patch: Patch a resource instance of type ImagingStudy by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImagingStudy/{id}/_history/{version_id}:
get:
tags:
- ImagingStudy
summary: "vread-instance: Read ImagingStudy instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImagingStudy:
get:
tags:
- ImagingStudy
summary: "search-type: Search for ImagingStudy instances"
description: This is a search type
parameters:
- name: reason
in: query
description: The reason for the study
required: false
schema:
type: string
- name: dicom-class
in: query
description: The type of the instance
required: false
schema:
type: string
- name: instance
in: query
description: SOP Instance UID for an instance
required: false
schema:
type: string
- name: modality
in: query
description: The modality of the series
required: false
schema:
type: string
- name: subject
in: query
description: Who the study is about
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: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: endpoint
in: query
description: The endpoint for the study or series
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: bodysite
in: query
description: The body site studied
required: false
schema:
type: string
- name: performer
in: query
description: The person who performed the study
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: interpreter
in: query
description: Who interpreted the images
required: false
schema:
type: string
- name: started
in: query
description: When the study was started
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: encounter
in: query
description: The context of the study
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: referrer
in: query
description: The referring physician
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: series
in: query
description: DICOM Series Instance UID for a series
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: basedon
in: query
description: The order for the image
required: false
schema:
type: string
- name: status
in: query
description: The status of the study
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:
- ImagingStudy
summary: "create-type: Create a new ImagingStudy instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ImagingStudy"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImagingStudy/_history:
get:
tags:
- ImagingStudy
summary: "type-history: Fetch the resource change history for all resources\
\ of type ImagingStudy"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImagingStudy/{id}/_history:
get:
tags:
- ImagingStudy
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ImagingStudy"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImagingStudy/_search:
get:
tags:
- ImagingStudy
summary: "search-type: Search for ImagingStudy instances"
description: This is a search type
parameters:
- name: reason
in: query
description: The reason for the study
required: false
schema:
type: string
- name: dicom-class
in: query
description: The type of the instance
required: false
schema:
type: string
- name: instance
in: query
description: SOP Instance UID for an instance
required: false
schema:
type: string
- name: modality
in: query
description: The modality of the series
required: false
schema:
type: string
- name: subject
in: query
description: Who the study is about
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: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: endpoint
in: query
description: The endpoint for the study or series
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: bodysite
in: query
description: The body site studied
required: false
schema:
type: string
- name: performer
in: query
description: The person who performed the study
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: interpreter
in: query
description: Who interpreted the images
required: false
schema:
type: string
- name: started
in: query
description: When the study was started
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: encounter
in: query
description: The context of the study
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: referrer
in: query
description: The referring physician
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: series
in: query
description: DICOM Series Instance UID for a series
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: basedon
in: query
description: The order for the image
required: false
schema:
type: string
- name: status
in: query
description: The status of the study
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"
/ImagingStudy/$validate:
get:
tags:
- ImagingStudy
summary: "GET: /ImagingStudy/$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:
- ImagingStudy
summary: "POST: /ImagingStudy/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ImagingStudy",
"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"
/ImagingStudy/{id}/$validate:
get:
tags:
- ImagingStudy
summary: "GET: /ImagingStudy/{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:
- ImagingStudy
summary: "POST: /ImagingStudy/{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": "ImagingStudy",
"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"
/ImagingStudy/{id}/$meta-delete:
post:
tags:
- ImagingStudy
summary: "POST: /ImagingStudy/{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"
/ImagingStudy/{id}/$meta-add:
post:
tags:
- ImagingStudy
summary: "POST: /ImagingStudy/{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"
/ImagingStudy/$meta:
get:
tags:
- ImagingStudy
summary: "GET: /ImagingStudy/$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:
- ImagingStudy
summary: "POST: /ImagingStudy/$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"
/ImagingStudy/{id}/$meta:
get:
tags:
- ImagingStudy
summary: "GET: /ImagingStudy/{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:
- ImagingStudy
summary: "POST: /ImagingStudy/{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"
/ImagingStudy/$expunge:
post:
tags:
- ImagingStudy
summary: "POST: /ImagingStudy/$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"
/ImagingStudy/{id}/$expunge:
post:
tags:
- ImagingStudy
summary: "POST: /ImagingStudy/{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"
/ImagingStudy/{id}/$diff:
get:
tags:
- ImagingStudy
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:
- ImagingStudy
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"
/Immunization/{id}:
get:
tags:
- Immunization
summary: "read-instance: Read Immunization instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Immunization
summary: "update-instance: Update an existing Immunization instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Immunization"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Immunization
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Immunization
summary: "instance-patch: Patch a resource instance of type Immunization by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Immunization/{id}/_history/{version_id}:
get:
tags:
- Immunization
summary: "vread-instance: Read Immunization instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Immunization:
get:
tags:
- Immunization
summary: "search-type: Search for Immunization instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: lot-number
in: query
description: Vaccine Lot Number
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: status-reason
in: query
description: Reason why the vaccine was not administered
required: false
schema:
type: string
- name: reason-code
in: query
description: Reason why the vaccine was administered
required: false
schema:
type: string
- name: manufacturer
in: query
description: Vaccine Manufacturer
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: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: reaction-date
in: query
description: When reaction started
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: performer
in: query
description: The practitioner or organization who played a role in the vaccination
required: false
schema:
type: string
- name: reaction
in: query
description: Additional information on reaction
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: target-disease
in: query
description: The target disease the dose is being administered against
required: false
schema:
type: string
- name: series
in: query
description: The series being followed by the provider
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: vaccine-code
in: query
description: Vaccine Product Administered
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: Why immunization occurred
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: The service delivery location or facility in which the vaccine
was / was to be administered
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: Immunization event status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Immunization
summary: "create-type: Create a new Immunization instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Immunization"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Immunization/_history:
get:
tags:
- Immunization
summary: "type-history: Fetch the resource change history for all resources\
\ of type Immunization"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Immunization/{id}/_history:
get:
tags:
- Immunization
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Immunization"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Immunization/_search:
get:
tags:
- Immunization
summary: "search-type: Search for Immunization instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: lot-number
in: query
description: Vaccine Lot Number
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: status-reason
in: query
description: Reason why the vaccine was not administered
required: false
schema:
type: string
- name: reason-code
in: query
description: Reason why the vaccine was administered
required: false
schema:
type: string
- name: manufacturer
in: query
description: Vaccine Manufacturer
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: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: reaction-date
in: query
description: When reaction started
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: performer
in: query
description: The practitioner or organization who played a role in the vaccination
required: false
schema:
type: string
- name: reaction
in: query
description: Additional information on reaction
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: target-disease
in: query
description: The target disease the dose is being administered against
required: false
schema:
type: string
- name: series
in: query
description: The series being followed by the provider
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: vaccine-code
in: query
description: Vaccine Product Administered
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: Why immunization occurred
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: The service delivery location or facility in which the vaccine
was / was to be administered
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: Immunization event status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Immunization/$validate:
get:
tags:
- Immunization
summary: "GET: /Immunization/$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:
- Immunization
summary: "POST: /Immunization/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Immunization",
"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"
/Immunization/{id}/$validate:
get:
tags:
- Immunization
summary: "GET: /Immunization/{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:
- Immunization
summary: "POST: /Immunization/{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": "Immunization",
"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"
/Immunization/{id}/$meta-delete:
post:
tags:
- Immunization
summary: "POST: /Immunization/{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"
/Immunization/{id}/$meta-add:
post:
tags:
- Immunization
summary: "POST: /Immunization/{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"
/Immunization/$meta:
get:
tags:
- Immunization
summary: "GET: /Immunization/$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:
- Immunization
summary: "POST: /Immunization/$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"
/Immunization/{id}/$meta:
get:
tags:
- Immunization
summary: "GET: /Immunization/{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:
- Immunization
summary: "POST: /Immunization/{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"
/Immunization/$expunge:
post:
tags:
- Immunization
summary: "POST: /Immunization/$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"
/Immunization/{id}/$expunge:
post:
tags:
- Immunization
summary: "POST: /Immunization/{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"
/Immunization/{id}/$diff:
get:
tags:
- Immunization
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:
- Immunization
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"
/ImmunizationEvaluation/{id}:
get:
tags:
- ImmunizationEvaluation
summary: "read-instance: Read ImmunizationEvaluation instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ImmunizationEvaluation
summary: "update-instance: Update an existing ImmunizationEvaluation instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ImmunizationEvaluation"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- ImmunizationEvaluation
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- ImmunizationEvaluation
summary: "instance-patch: Patch a resource instance of type ImmunizationEvaluation\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImmunizationEvaluation/{id}/_history/{version_id}:
get:
tags:
- ImmunizationEvaluation
summary: "vread-instance: Read ImmunizationEvaluation instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImmunizationEvaluation:
get:
tags:
- ImmunizationEvaluation
summary: "search-type: Search for ImmunizationEvaluation instances"
description: This is a search type
parameters:
- name: date
in: query
description: Date the evaluation was generated
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: ID of the evaluation
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: dose-status
in: query
description: The status of the dose relative to published recommendations
required: false
schema:
type: string
- name: immunization-event
in: query
description: The vaccine administration event being evaluated
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: target-disease
in: query
description: The vaccine preventable disease being evaluated against
required: false
schema:
type: string
- name: patient
in: query
description: The patient being evaluated
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: Immunization evaluation status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- ImmunizationEvaluation
summary: "create-type: Create a new ImmunizationEvaluation instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ImmunizationEvaluation"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImmunizationEvaluation/_history:
get:
tags:
- ImmunizationEvaluation
summary: "type-history: Fetch the resource change history for all resources\
\ of type ImmunizationEvaluation"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImmunizationEvaluation/{id}/_history:
get:
tags:
- ImmunizationEvaluation
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ImmunizationEvaluation"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImmunizationEvaluation/_search:
get:
tags:
- ImmunizationEvaluation
summary: "search-type: Search for ImmunizationEvaluation instances"
description: This is a search type
parameters:
- name: date
in: query
description: Date the evaluation was generated
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: ID of the evaluation
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: dose-status
in: query
description: The status of the dose relative to published recommendations
required: false
schema:
type: string
- name: immunization-event
in: query
description: The vaccine administration event being evaluated
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: target-disease
in: query
description: The vaccine preventable disease being evaluated against
required: false
schema:
type: string
- name: patient
in: query
description: The patient being evaluated
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: Immunization evaluation status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImmunizationEvaluation/$validate:
get:
tags:
- ImmunizationEvaluation
summary: "GET: /ImmunizationEvaluation/$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:
- ImmunizationEvaluation
summary: "POST: /ImmunizationEvaluation/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ImmunizationEvaluation",
"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"
/ImmunizationEvaluation/{id}/$validate:
get:
tags:
- ImmunizationEvaluation
summary: "GET: /ImmunizationEvaluation/{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:
- ImmunizationEvaluation
summary: "POST: /ImmunizationEvaluation/{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": "ImmunizationEvaluation",
"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"
/ImmunizationEvaluation/{id}/$meta-delete:
post:
tags:
- ImmunizationEvaluation
summary: "POST: /ImmunizationEvaluation/{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"
/ImmunizationEvaluation/{id}/$meta-add:
post:
tags:
- ImmunizationEvaluation
summary: "POST: /ImmunizationEvaluation/{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"
/ImmunizationEvaluation/$meta:
get:
tags:
- ImmunizationEvaluation
summary: "GET: /ImmunizationEvaluation/$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:
- ImmunizationEvaluation
summary: "POST: /ImmunizationEvaluation/$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"
/ImmunizationEvaluation/{id}/$meta:
get:
tags:
- ImmunizationEvaluation
summary: "GET: /ImmunizationEvaluation/{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:
- ImmunizationEvaluation
summary: "POST: /ImmunizationEvaluation/{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"
/ImmunizationEvaluation/$expunge:
post:
tags:
- ImmunizationEvaluation
summary: "POST: /ImmunizationEvaluation/$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"
/ImmunizationEvaluation/{id}/$expunge:
post:
tags:
- ImmunizationEvaluation
summary: "POST: /ImmunizationEvaluation/{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"
/ImmunizationEvaluation/{id}/$diff:
get:
tags:
- ImmunizationEvaluation
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:
- ImmunizationEvaluation
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"
/ImmunizationRecommendation/{id}:
get:
tags:
- ImmunizationRecommendation
summary: "read-instance: Read ImmunizationRecommendation instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ImmunizationRecommendation
summary: "update-instance: Update an existing ImmunizationRecommendation instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ImmunizationRecommendation"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- ImmunizationRecommendation
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- ImmunizationRecommendation
summary: "instance-patch: Patch a resource instance of type ImmunizationRecommendation\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImmunizationRecommendation/{id}/_history/{version_id}:
get:
tags:
- ImmunizationRecommendation
summary: "vread-instance: Read ImmunizationRecommendation instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImmunizationRecommendation:
get:
tags:
- ImmunizationRecommendation
summary: "search-type: Search for ImmunizationRecommendation instances"
description: This is a search type
parameters:
- name: date
in: query
description: Date recommendation(s) created
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: Business identifier
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: vaccine-type
in: query
description: Vaccine or vaccine group recommendation applies to
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: target-disease
in: query
description: Disease to be immunized against
required: false
schema:
type: string
- name: patient
in: query
description: Who this profile is for
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: information
in: query
description: Patient observations supporting recommendation
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: support
in: query
description: Past immunizations supporting recommendation
required: false
schema:
type: string
- name: status
in: query
description: Vaccine recommendation status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- ImmunizationRecommendation
summary: "create-type: Create a new ImmunizationRecommendation instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ImmunizationRecommendation"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImmunizationRecommendation/_history:
get:
tags:
- ImmunizationRecommendation
summary: "type-history: Fetch the resource change history for all resources\
\ of type ImmunizationRecommendation"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImmunizationRecommendation/{id}/_history:
get:
tags:
- ImmunizationRecommendation
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ImmunizationRecommendation"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImmunizationRecommendation/_search:
get:
tags:
- ImmunizationRecommendation
summary: "search-type: Search for ImmunizationRecommendation instances"
description: This is a search type
parameters:
- name: date
in: query
description: Date recommendation(s) created
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: Business identifier
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: vaccine-type
in: query
description: Vaccine or vaccine group recommendation applies to
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: target-disease
in: query
description: Disease to be immunized against
required: false
schema:
type: string
- name: patient
in: query
description: Who this profile is for
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: information
in: query
description: Patient observations supporting recommendation
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: support
in: query
description: Past immunizations supporting recommendation
required: false
schema:
type: string
- name: status
in: query
description: Vaccine recommendation status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImmunizationRecommendation/$validate:
get:
tags:
- ImmunizationRecommendation
summary: "GET: /ImmunizationRecommendation/$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:
- ImmunizationRecommendation
summary: "POST: /ImmunizationRecommendation/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ImmunizationRecommendation",
"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"
/ImmunizationRecommendation/{id}/$validate:
get:
tags:
- ImmunizationRecommendation
summary: "GET: /ImmunizationRecommendation/{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:
- ImmunizationRecommendation
summary: "POST: /ImmunizationRecommendation/{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": "ImmunizationRecommendation",
"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"
/ImmunizationRecommendation/{id}/$meta-delete:
post:
tags:
- ImmunizationRecommendation
summary: "POST: /ImmunizationRecommendation/{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"
/ImmunizationRecommendation/{id}/$meta-add:
post:
tags:
- ImmunizationRecommendation
summary: "POST: /ImmunizationRecommendation/{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"
/ImmunizationRecommendation/$meta:
get:
tags:
- ImmunizationRecommendation
summary: "GET: /ImmunizationRecommendation/$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:
- ImmunizationRecommendation
summary: "POST: /ImmunizationRecommendation/$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"
/ImmunizationRecommendation/{id}/$meta:
get:
tags:
- ImmunizationRecommendation
summary: "GET: /ImmunizationRecommendation/{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:
- ImmunizationRecommendation
summary: "POST: /ImmunizationRecommendation/{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"
/ImmunizationRecommendation/$expunge:
post:
tags:
- ImmunizationRecommendation
summary: "POST: /ImmunizationRecommendation/$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"
/ImmunizationRecommendation/{id}/$expunge:
post:
tags:
- ImmunizationRecommendation
summary: "POST: /ImmunizationRecommendation/{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"
/ImmunizationRecommendation/{id}/$diff:
get:
tags:
- ImmunizationRecommendation
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:
- ImmunizationRecommendation
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"
/ImplementationGuide/{id}:
get:
tags:
- ImplementationGuide
summary: "read-instance: Read ImplementationGuide instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ImplementationGuide
summary: "update-instance: Update an existing ImplementationGuide instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ImplementationGuide"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- ImplementationGuide
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- ImplementationGuide
summary: "instance-patch: Patch a resource instance of type ImplementationGuide\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImplementationGuide/{id}/_history/{version_id}:
get:
tags:
- ImplementationGuide
summary: "vread-instance: Read ImplementationGuide instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImplementationGuide:
get:
tags:
- ImplementationGuide
summary: "search-type: Search for ImplementationGuide instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: experimental
in: query
description: "For testing purposes, not real usage"
required: false
schema:
type: string
- name: global
in: query
description: Profile that all resources must conform to
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: Identity of the IG that this depends on
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: resource
in: query
description: Location of the resource
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- ImplementationGuide
summary: "create-type: Create a new ImplementationGuide instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ImplementationGuide"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImplementationGuide/_history:
get:
tags:
- ImplementationGuide
summary: "type-history: Fetch the resource change history for all resources\
\ of type ImplementationGuide"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImplementationGuide/{id}/_history:
get:
tags:
- ImplementationGuide
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ImplementationGuide"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImplementationGuide/_search:
get:
tags:
- ImplementationGuide
summary: "search-type: Search for ImplementationGuide instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: experimental
in: query
description: "For testing purposes, not real usage"
required: false
schema:
type: string
- name: global
in: query
description: Profile that all resources must conform to
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: Identity of the IG that this depends on
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: resource
in: query
description: Location of the resource
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ImplementationGuide/$validate:
get:
tags:
- ImplementationGuide
summary: "GET: /ImplementationGuide/$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:
- ImplementationGuide
summary: "POST: /ImplementationGuide/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ImplementationGuide",
"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"
/ImplementationGuide/{id}/$validate:
get:
tags:
- ImplementationGuide
summary: "GET: /ImplementationGuide/{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:
- ImplementationGuide
summary: "POST: /ImplementationGuide/{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": "ImplementationGuide",
"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"
/ImplementationGuide/{id}/$meta-delete:
post:
tags:
- ImplementationGuide
summary: "POST: /ImplementationGuide/{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"
/ImplementationGuide/{id}/$meta-add:
post:
tags:
- ImplementationGuide
summary: "POST: /ImplementationGuide/{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"
/ImplementationGuide/$meta:
get:
tags:
- ImplementationGuide
summary: "GET: /ImplementationGuide/$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:
- ImplementationGuide
summary: "POST: /ImplementationGuide/$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"
/ImplementationGuide/{id}/$meta:
get:
tags:
- ImplementationGuide
summary: "GET: /ImplementationGuide/{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:
- ImplementationGuide
summary: "POST: /ImplementationGuide/{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"
/ImplementationGuide/$expunge:
post:
tags:
- ImplementationGuide
summary: "POST: /ImplementationGuide/$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"
/ImplementationGuide/{id}/$expunge:
post:
tags:
- ImplementationGuide
summary: "POST: /ImplementationGuide/{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"
/ImplementationGuide/{id}/$diff:
get:
tags:
- ImplementationGuide
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:
- ImplementationGuide
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"
/InsurancePlan/{id}:
get:
tags:
- InsurancePlan
summary: "read-instance: Read InsurancePlan instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- InsurancePlan
summary: "update-instance: Update an existing InsurancePlan instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "InsurancePlan"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- InsurancePlan
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- InsurancePlan
summary: "instance-patch: Patch a resource instance of type InsurancePlan by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan/{id}/_history/{version_id}:
get:
tags:
- InsurancePlan
summary: "vread-instance: Read InsurancePlan instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan:
get:
tags:
- InsurancePlan
summary: "search-type: Search for InsurancePlan instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Any identifier for the organization (not the accreditation issuer's
identifier)
required: false
schema:
type: string
- name: address
in: query
description: "A server defined search that may match any of the string fields\
\ in the Address, including line, city, district, state, country, postalCode,\
\ and/or text"
required: false
schema:
type: string
- name: address-state
in: query
description: A state specified in an address
required: false
schema:
type: string
- name: owned-by
in: query
description: An organization of which this organization forms a part
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: A code for the type of organization
required: false
schema:
type: string
- name: address-postalcode
in: query
description: A postal code specified in an address
required: false
schema:
type: string
- name: address-country
in: query
description: A country specified in an address
required: false
schema:
type: string
- name: administered-by
in: query
description: Product administrator
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoint
required: false
schema:
type: string
- name: phonetic
in: query
description: A portion of the organization's name using some kind of phonetic
matching algorithm
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: A use code specified in an address
required: false
schema:
type: string
- name: name
in: query
description: A portion of the organization's name or alias
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: address-city
in: query
description: A city specified in an address
required: false
schema:
type: string
- name: status
in: query
description: Is the Organization record active
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- InsurancePlan
summary: "create-type: Create a new InsurancePlan instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "InsurancePlan"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan/_history:
get:
tags:
- InsurancePlan
summary: "type-history: Fetch the resource change history for all resources\
\ of type InsurancePlan"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan/{id}/_history:
get:
tags:
- InsurancePlan
summary: "instance-history: Fetch the resource change history for all resources\
\ of type InsurancePlan"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan/_search:
get:
tags:
- InsurancePlan
summary: "search-type: Search for InsurancePlan instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Any identifier for the organization (not the accreditation issuer's
identifier)
required: false
schema:
type: string
- name: address
in: query
description: "A server defined search that may match any of the string fields\
\ in the Address, including line, city, district, state, country, postalCode,\
\ and/or text"
required: false
schema:
type: string
- name: address-state
in: query
description: A state specified in an address
required: false
schema:
type: string
- name: owned-by
in: query
description: An organization of which this organization forms a part
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: A code for the type of organization
required: false
schema:
type: string
- name: address-postalcode
in: query
description: A postal code specified in an address
required: false
schema:
type: string
- name: address-country
in: query
description: A country specified in an address
required: false
schema:
type: string
- name: administered-by
in: query
description: Product administrator
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoint
required: false
schema:
type: string
- name: phonetic
in: query
description: A portion of the organization's name using some kind of phonetic
matching algorithm
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: A use code specified in an address
required: false
schema:
type: string
- name: name
in: query
description: A portion of the organization's name or alias
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: address-city
in: query
description: A city specified in an address
required: false
schema:
type: string
- name: status
in: query
description: Is the Organization record active
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan/$validate:
get:
tags:
- InsurancePlan
summary: "GET: /InsurancePlan/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "InsurancePlan",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan/{id}/$validate:
get:
tags:
- InsurancePlan
summary: "GET: /InsurancePlan/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "InsurancePlan",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan/{id}/$meta-delete:
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan/{id}/$meta-add:
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan/$meta:
get:
tags:
- InsurancePlan
summary: "GET: /InsurancePlan/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan/{id}/$meta:
get:
tags:
- InsurancePlan
summary: "GET: /InsurancePlan/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan/$expunge:
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan/{id}/$expunge:
post:
tags:
- InsurancePlan
summary: "POST: /InsurancePlan/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/InsurancePlan/{id}/$diff:
get:
tags:
- InsurancePlan
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:
- InsurancePlan
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"
/Invoice/{id}:
get:
tags:
- Invoice
summary: "read-instance: Read Invoice instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Invoice
summary: "update-instance: Update an existing Invoice instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Invoice"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Invoice
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Invoice
summary: "instance-patch: Patch a resource instance of type Invoice by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Invoice/{id}/_history/{version_id}:
get:
tags:
- Invoice
summary: "vread-instance: Read Invoice instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Invoice:
get:
tags:
- Invoice
summary: "search-type: Search for Invoice instances"
description: This is a search type
parameters:
- name: date
in: query
description: Invoice date / posting date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: Business Identifier for item
required: false
schema:
type: string
- name: totalgross
in: query
description: Gross total of this Invoice
required: false
schema:
anyOf:
- type: string
- type: number
- name: participant-role
in: query
description: Type of involvement in creation of this Invoice
required: false
schema:
type: string
- name: subject
in: query
description: Recipient(s) of goods and services
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: Type of Invoice
required: false
schema:
type: string
- name: issuer
in: query
description: Issuing Organization of Invoice
required: false
schema:
type: string
- name: participant
in: query
description: Individual who was involved
required: false
schema:
type: string
- name: totalnet
in: query
description: Net total of this Invoice
required: false
schema:
anyOf:
- type: string
- type: number
- 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: Recipient(s) of goods and services
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: recipient
in: query
description: Recipient of this invoice
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: Account that is being balanced
required: false
schema:
type: string
- name: status
in: query
description: draft | issued | balanced | cancelled | entered-in-error
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:
- Invoice
summary: "create-type: Create a new Invoice instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Invoice"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Invoice/_history:
get:
tags:
- Invoice
summary: "type-history: Fetch the resource change history for all resources\
\ of type Invoice"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Invoice/{id}/_history:
get:
tags:
- Invoice
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Invoice"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Invoice/_search:
get:
tags:
- Invoice
summary: "search-type: Search for Invoice instances"
description: This is a search type
parameters:
- name: date
in: query
description: Invoice date / posting date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: Business Identifier for item
required: false
schema:
type: string
- name: totalgross
in: query
description: Gross total of this Invoice
required: false
schema:
anyOf:
- type: string
- type: number
- name: participant-role
in: query
description: Type of involvement in creation of this Invoice
required: false
schema:
type: string
- name: subject
in: query
description: Recipient(s) of goods and services
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: Type of Invoice
required: false
schema:
type: string
- name: issuer
in: query
description: Issuing Organization of Invoice
required: false
schema:
type: string
- name: participant
in: query
description: Individual who was involved
required: false
schema:
type: string
- name: totalnet
in: query
description: Net total of this Invoice
required: false
schema:
anyOf:
- type: string
- type: number
- 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: Recipient(s) of goods and services
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: recipient
in: query
description: Recipient of this invoice
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: Account that is being balanced
required: false
schema:
type: string
- name: status
in: query
description: draft | issued | balanced | cancelled | entered-in-error
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"
/Invoice/$validate:
get:
tags:
- Invoice
summary: "GET: /Invoice/$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:
- Invoice
summary: "POST: /Invoice/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Invoice",
"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"
/Invoice/{id}/$validate:
get:
tags:
- Invoice
summary: "GET: /Invoice/{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:
- Invoice
summary: "POST: /Invoice/{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": "Invoice",
"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"
/Invoice/{id}/$meta-delete:
post:
tags:
- Invoice
summary: "POST: /Invoice/{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"
/Invoice/{id}/$meta-add:
post:
tags:
- Invoice
summary: "POST: /Invoice/{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"
/Invoice/$meta:
get:
tags:
- Invoice
summary: "GET: /Invoice/$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:
- Invoice
summary: "POST: /Invoice/$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"
/Invoice/{id}/$meta:
get:
tags:
- Invoice
summary: "GET: /Invoice/{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:
- Invoice
summary: "POST: /Invoice/{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"
/Invoice/$expunge:
post:
tags:
- Invoice
summary: "POST: /Invoice/$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"
/Invoice/{id}/$expunge:
post:
tags:
- Invoice
summary: "POST: /Invoice/{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"
/Invoice/{id}/$diff:
get:
tags:
- Invoice
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:
- Invoice
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"
/Library/{id}:
get:
tags:
- Library
summary: "read-instance: Read Library instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Library
summary: "update-instance: Update an existing Library instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Library"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Library
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Library
summary: "instance-patch: Patch a resource instance of type Library by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Library/{id}/_history/{version_id}:
get:
tags:
- Library
summary: "vread-instance: Read Library instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Library:
get:
tags:
- Library
summary: "search-type: Search for Library instances"
description: This is a search type
parameters:
- name: date
in: query
description: The library publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the library
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the library
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the library
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the library
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the library
required: false
schema:
type: string
- name: type
in: query
description: "The type of the library (e.g. logic-library, model-definition,\
\ asset-collection, module-definition)"
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: A quantity- or range-valued use context assigned to the library
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the library is intended to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the library
required: false
schema:
type: string
- name: content-type
in: query
description: The type of content in the library (e.g. text/cql)
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the library
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the library
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: The business version of the library
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the library
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: Computationally friendly name of the library
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the library
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the module
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 library
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:
- Library
summary: "create-type: Create a new Library instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Library"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Library/_history:
get:
tags:
- Library
summary: "type-history: Fetch the resource change history for all resources\
\ of type Library"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Library/{id}/_history:
get:
tags:
- Library
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Library"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Library/_search:
get:
tags:
- Library
summary: "search-type: Search for Library instances"
description: This is a search type
parameters:
- name: date
in: query
description: The library publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the library
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the library
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the library
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the library
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the library
required: false
schema:
type: string
- name: type
in: query
description: "The type of the library (e.g. logic-library, model-definition,\
\ asset-collection, module-definition)"
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: A quantity- or range-valued use context assigned to the library
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the library is intended to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the library
required: false
schema:
type: string
- name: content-type
in: query
description: The type of content in the library (e.g. text/cql)
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the library
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the library
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: The business version of the library
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the library
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: Computationally friendly name of the library
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the library
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the module
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 library
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"
/Library/$validate:
get:
tags:
- Library
summary: "GET: /Library/$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:
- Library
summary: "POST: /Library/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Library",
"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"
/Library/{id}/$validate:
get:
tags:
- Library
summary: "GET: /Library/{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:
- Library
summary: "POST: /Library/{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": "Library",
"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"
/Library/{id}/$meta-delete:
post:
tags:
- Library
summary: "POST: /Library/{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"
/Library/{id}/$meta-add:
post:
tags:
- Library
summary: "POST: /Library/{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"
/Library/$meta:
get:
tags:
- Library
summary: "GET: /Library/$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:
- Library
summary: "POST: /Library/$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"
/Library/{id}/$meta:
get:
tags:
- Library
summary: "GET: /Library/{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:
- Library
summary: "POST: /Library/{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"
/Library/$expunge:
post:
tags:
- Library
summary: "POST: /Library/$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"
/Library/{id}/$expunge:
post:
tags:
- Library
summary: "POST: /Library/{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"
/Library/{id}/$diff:
get:
tags:
- Library
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:
- Library
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"
/Linkage/{id}:
get:
tags:
- Linkage
summary: "read-instance: Read Linkage instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Linkage
summary: "update-instance: Update an existing Linkage instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Linkage"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Linkage
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Linkage
summary: "instance-patch: Patch a resource instance of type Linkage by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Linkage/{id}/_history/{version_id}:
get:
tags:
- Linkage
summary: "vread-instance: Read Linkage instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Linkage:
get:
tags:
- Linkage
summary: "search-type: Search for Linkage instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: item
in: query
description: Matches on any item in the Linkage
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: author
in: query
description: Author of the Linkage
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: _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: _security
in: query
description: Security Labels applied to this resource
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: source
in: query
description: Matches on any item in the Linkage with a type of 'source'
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Linkage
summary: "create-type: Create a new Linkage instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Linkage"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Linkage/_history:
get:
tags:
- Linkage
summary: "type-history: Fetch the resource change history for all resources\
\ of type Linkage"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Linkage/{id}/_history:
get:
tags:
- Linkage
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Linkage"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Linkage/_search:
get:
tags:
- Linkage
summary: "search-type: Search for Linkage instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: item
in: query
description: Matches on any item in the Linkage
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: author
in: query
description: Author of the Linkage
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: _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: _security
in: query
description: Security Labels applied to this resource
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: source
in: query
description: Matches on any item in the Linkage with a type of 'source'
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Linkage/$validate:
get:
tags:
- Linkage
summary: "GET: /Linkage/$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:
- Linkage
summary: "POST: /Linkage/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Linkage",
"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"
/Linkage/{id}/$validate:
get:
tags:
- Linkage
summary: "GET: /Linkage/{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:
- Linkage
summary: "POST: /Linkage/{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": "Linkage",
"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"
/Linkage/{id}/$meta-delete:
post:
tags:
- Linkage
summary: "POST: /Linkage/{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"
/Linkage/{id}/$meta-add:
post:
tags:
- Linkage
summary: "POST: /Linkage/{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"
/Linkage/$meta:
get:
tags:
- Linkage
summary: "GET: /Linkage/$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:
- Linkage
summary: "POST: /Linkage/$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"
/Linkage/{id}/$meta:
get:
tags:
- Linkage
summary: "GET: /Linkage/{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:
- Linkage
summary: "POST: /Linkage/{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"
/Linkage/$expunge:
post:
tags:
- Linkage
summary: "POST: /Linkage/$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"
/Linkage/{id}/$expunge:
post:
tags:
- Linkage
summary: "POST: /Linkage/{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"
/Linkage/{id}/$diff:
get:
tags:
- Linkage
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:
- Linkage
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"
/List/{id}:
get:
tags:
- List
summary: "read-instance: Read List instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- List
summary: "update-instance: Update an existing List instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "List"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- List
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- List
summary: "instance-patch: Patch a resource instance of type List by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/List/{id}/_history/{version_id}:
get:
tags:
- List
summary: "vread-instance: Read List instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/List:
get:
tags:
- List
summary: "search-type: Search for List instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: empty-reason
in: query
description: Why list is empty
required: false
schema:
type: string
- name: item
in: query
description: Actual entry
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: notes
in: query
description: The annotation - text content (as markdown)
required: false
schema:
type: string
- name: subject
in: query
description: If all resources have the same subject
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* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: source
in: query
description: Who and/or what defined the list contents (aka Author)
required: false
schema:
type: string
- name: title
in: query
description: Descriptive name for the list
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: current | retired | entered-in-error
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:
- List
summary: "create-type: Create a new List instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "List"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/List/_history:
get:
tags:
- List
summary: "type-history: Fetch the resource change history for all resources\
\ of type List"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/List/{id}/_history:
get:
tags:
- List
summary: "instance-history: Fetch the resource change history for all resources\
\ of type List"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/List/_search:
get:
tags:
- List
summary: "search-type: Search for List instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: empty-reason
in: query
description: Why list is empty
required: false
schema:
type: string
- name: item
in: query
description: Actual entry
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: notes
in: query
description: The annotation - text content (as markdown)
required: false
schema:
type: string
- name: subject
in: query
description: If all resources have the same subject
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* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: source
in: query
description: Who and/or what defined the list contents (aka Author)
required: false
schema:
type: string
- name: title
in: query
description: Descriptive name for the list
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: current | retired | entered-in-error
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"
/List/$validate:
get:
tags:
- List
summary: "GET: /List/$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:
- List
summary: "POST: /List/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "List",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/List/{id}/$validate:
get:
tags:
- List
summary: "GET: /List/{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:
- List
summary: "POST: /List/{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": "List",
"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"
/List/{id}/$meta-delete:
post:
tags:
- List
summary: "POST: /List/{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"
/List/{id}/$meta-add:
post:
tags:
- List
summary: "POST: /List/{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"
/List/$meta:
get:
tags:
- List
summary: "GET: /List/$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:
- List
summary: "POST: /List/$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"
/List/{id}/$meta:
get:
tags:
- List
summary: "GET: /List/{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:
- List
summary: "POST: /List/{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"
/List/$expunge:
post:
tags:
- List
summary: "POST: /List/$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"
/List/{id}/$expunge:
post:
tags:
- List
summary: "POST: /List/{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"
/List/{id}/$diff:
get:
tags:
- List
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:
- List
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"
/Location/{id}:
get:
tags:
- Location
summary: "read-instance: Read Location instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Location
summary: "update-instance: Update an existing Location instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Location"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Location
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Location
summary: "instance-patch: Patch a resource instance of type Location by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location/{id}/_history/{version_id}:
get:
tags:
- Location
summary: "vread-instance: Read Location instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location:
get:
tags:
- Location
summary: "search-type: Search for Location instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: An identifier for the location
required: false
schema:
type: string
- name: partof
in: query
description: A location of which this location is a part
required: false
schema:
type: string
- name: address
in: query
description: A (part of the) address of the location
required: false
schema:
type: string
- name: address-state
in: query
description: A state specified in an address
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: operational-status
in: query
description: "Searches for locations (typically bed/room) that have an operational\
\ status (e.g. contaminated, housekeeping)"
required: false
schema:
type: string
- name: type
in: query
description: A code for the type of location
required: false
schema:
type: string
- name: address-postalcode
in: query
description: A postal code specified in an address
required: false
schema:
type: string
- name: address-country
in: query
description: A country specified in an address
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the location
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: Searches for locations that are managed by the provided organization
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: A use code specified in an address
required: false
schema:
type: string
- name: name
in: query
description: A portion of the location's name or alias
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: near
in: query
description: |-
Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes).
If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant)
Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency.
Requires the near-distance parameter to be provided also
required: false
schema:
type: string
- name: address-city
in: query
description: A city specified in an address
required: false
schema:
type: string
- name: status
in: query
description: Searches for locations with a specific kind of status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Location
summary: "create-type: Create a new Location instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Location"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location/_history:
get:
tags:
- Location
summary: "type-history: Fetch the resource change history for all resources\
\ of type Location"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location/{id}/_history:
get:
tags:
- Location
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Location"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location/_search:
get:
tags:
- Location
summary: "search-type: Search for Location instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: An identifier for the location
required: false
schema:
type: string
- name: partof
in: query
description: A location of which this location is a part
required: false
schema:
type: string
- name: address
in: query
description: A (part of the) address of the location
required: false
schema:
type: string
- name: address-state
in: query
description: A state specified in an address
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: operational-status
in: query
description: "Searches for locations (typically bed/room) that have an operational\
\ status (e.g. contaminated, housekeeping)"
required: false
schema:
type: string
- name: type
in: query
description: A code for the type of location
required: false
schema:
type: string
- name: address-postalcode
in: query
description: A postal code specified in an address
required: false
schema:
type: string
- name: address-country
in: query
description: A country specified in an address
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the location
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: Searches for locations that are managed by the provided organization
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: A use code specified in an address
required: false
schema:
type: string
- name: name
in: query
description: A portion of the location's name or alias
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: near
in: query
description: |-
Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes).
If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant)
Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency.
Requires the near-distance parameter to be provided also
required: false
schema:
type: string
- name: address-city
in: query
description: A city specified in an address
required: false
schema:
type: string
- name: status
in: query
description: Searches for locations with a specific kind of status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location/$validate:
get:
tags:
- Location
summary: "GET: /Location/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Location
summary: "POST: /Location/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Location",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location/{id}/$validate:
get:
tags:
- Location
summary: "GET: /Location/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Location
summary: "POST: /Location/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Location",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location/{id}/$meta-delete:
post:
tags:
- Location
summary: "POST: /Location/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location/{id}/$meta-add:
post:
tags:
- Location
summary: "POST: /Location/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location/$meta:
get:
tags:
- Location
summary: "GET: /Location/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Location
summary: "POST: /Location/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location/{id}/$meta:
get:
tags:
- Location
summary: "GET: /Location/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Location
summary: "POST: /Location/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location/$expunge:
post:
tags:
- Location
summary: "POST: /Location/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location/{id}/$expunge:
post:
tags:
- Location
summary: "POST: /Location/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Location/{id}/$diff:
get:
tags:
- Location
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:
- Location
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"
/Measure/{id}:
get:
tags:
- Measure
summary: "read-instance: Read Measure instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Measure
summary: "update-instance: Update an existing Measure instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Measure"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Measure
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Measure
summary: "instance-patch: Patch a resource instance of type Measure by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Measure/{id}/_history/{version_id}:
get:
tags:
- Measure
summary: "vread-instance: Read Measure instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Measure:
get:
tags:
- Measure
summary: "search-type: Search for Measure instances"
description: This is a search type
parameters:
- name: date
in: query
description: The measure publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the measure
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the measure
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the measure
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the measure
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the measure
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: A quantity- or range-valued use context assigned to the measure
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the measure is intended to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the measure
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the measure
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the measure
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: The business version of the measure
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the measure
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: Computationally friendly name of the measure
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the measure
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the measure
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 measure
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:
- Measure
summary: "create-type: Create a new Measure instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Measure"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Measure/_history:
get:
tags:
- Measure
summary: "type-history: Fetch the resource change history for all resources\
\ of type Measure"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Measure/{id}/_history:
get:
tags:
- Measure
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Measure"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Measure/_search:
get:
tags:
- Measure
summary: "search-type: Search for Measure instances"
description: This is a search type
parameters:
- name: date
in: query
description: The measure publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the measure
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the measure
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the measure
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the measure
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the measure
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: A quantity- or range-valued use context assigned to the measure
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the measure is intended to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the measure
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the measure
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the measure
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: The business version of the measure
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the measure
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: Computationally friendly name of the measure
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the measure
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the measure
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 measure
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"
/Measure/$validate:
get:
tags:
- Measure
summary: "GET: /Measure/$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:
- Measure
summary: "POST: /Measure/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Measure",
"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"
/Measure/{id}/$validate:
get:
tags:
- Measure
summary: "GET: /Measure/{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:
- Measure
summary: "POST: /Measure/{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": "Measure",
"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"
/Measure/{id}/$meta-delete:
post:
tags:
- Measure
summary: "POST: /Measure/{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"
/Measure/{id}/$meta-add:
post:
tags:
- Measure
summary: "POST: /Measure/{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"
/Measure/$meta:
get:
tags:
- Measure
summary: "GET: /Measure/$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:
- Measure
summary: "POST: /Measure/$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"
/Measure/{id}/$meta:
get:
tags:
- Measure
summary: "GET: /Measure/{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:
- Measure
summary: "POST: /Measure/{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"
/Measure/$expunge:
post:
tags:
- Measure
summary: "POST: /Measure/$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"
/Measure/{id}/$expunge:
post:
tags:
- Measure
summary: "POST: /Measure/{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"
/Measure/{id}/$diff:
get:
tags:
- Measure
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:
- Measure
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"
/MeasureReport/{id}:
get:
tags:
- MeasureReport
summary: "read-instance: Read MeasureReport instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MeasureReport
summary: "update-instance: Update an existing MeasureReport instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MeasureReport"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- MeasureReport
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- MeasureReport
summary: "instance-patch: Patch a resource instance of type MeasureReport by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MeasureReport/{id}/_history/{version_id}:
get:
tags:
- MeasureReport
summary: "vread-instance: Read MeasureReport instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MeasureReport:
get:
tags:
- MeasureReport
summary: "search-type: Search for MeasureReport instances"
description: This is a search type
parameters:
- name: date
in: query
description: The date of the measure report
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: External identifier of the measure report to be returned
required: false
schema:
type: string
- name: period
in: query
description: The period of the measure report
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: The identity of a subject to search for individual measure report
results for
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: reporter
in: query
description: The reporter to return measure report results for
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: measure
in: query
description: The measure to return measure report results for
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 identity of a patient to search for individual measure report
results for
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: evaluated-resource
in: query
description: An evaluated resource referenced by the measure report
required: false
schema:
type: string
- name: status
in: query
description: The status of the measure report
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:
- MeasureReport
summary: "create-type: Create a new MeasureReport instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MeasureReport"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MeasureReport/_history:
get:
tags:
- MeasureReport
summary: "type-history: Fetch the resource change history for all resources\
\ of type MeasureReport"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MeasureReport/{id}/_history:
get:
tags:
- MeasureReport
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MeasureReport"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MeasureReport/_search:
get:
tags:
- MeasureReport
summary: "search-type: Search for MeasureReport instances"
description: This is a search type
parameters:
- name: date
in: query
description: The date of the measure report
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: External identifier of the measure report to be returned
required: false
schema:
type: string
- name: period
in: query
description: The period of the measure report
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: The identity of a subject to search for individual measure report
results for
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: reporter
in: query
description: The reporter to return measure report results for
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: measure
in: query
description: The measure to return measure report results for
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 identity of a patient to search for individual measure report
results for
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: evaluated-resource
in: query
description: An evaluated resource referenced by the measure report
required: false
schema:
type: string
- name: status
in: query
description: The status of the measure report
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"
/MeasureReport/$validate:
get:
tags:
- MeasureReport
summary: "GET: /MeasureReport/$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:
- MeasureReport
summary: "POST: /MeasureReport/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MeasureReport",
"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"
/MeasureReport/{id}/$validate:
get:
tags:
- MeasureReport
summary: "GET: /MeasureReport/{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:
- MeasureReport
summary: "POST: /MeasureReport/{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": "MeasureReport",
"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"
/MeasureReport/{id}/$meta-delete:
post:
tags:
- MeasureReport
summary: "POST: /MeasureReport/{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"
/MeasureReport/{id}/$meta-add:
post:
tags:
- MeasureReport
summary: "POST: /MeasureReport/{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"
/MeasureReport/$meta:
get:
tags:
- MeasureReport
summary: "GET: /MeasureReport/$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:
- MeasureReport
summary: "POST: /MeasureReport/$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"
/MeasureReport/{id}/$meta:
get:
tags:
- MeasureReport
summary: "GET: /MeasureReport/{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:
- MeasureReport
summary: "POST: /MeasureReport/{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"
/MeasureReport/$expunge:
post:
tags:
- MeasureReport
summary: "POST: /MeasureReport/$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"
/MeasureReport/{id}/$expunge:
post:
tags:
- MeasureReport
summary: "POST: /MeasureReport/{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"
/MeasureReport/{id}/$diff:
get:
tags:
- MeasureReport
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:
- MeasureReport
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"
/Media/{id}:
get:
tags:
- Media
summary: "read-instance: Read Media instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Media
summary: "update-instance: Update an existing Media 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": "Media"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- Media
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:
- Media
summary: "instance-patch: Patch a resource instance of type Media 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"
/Media/{id}/_history/{version_id}:
get:
tags:
- Media
summary: "vread-instance: Read Media instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Media:
get:
tags:
- Media
summary: "search-type: Search for Media instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Identifier(s) for the image
required: false
schema:
type: string
- name: modality
in: query
description: The type of acquisition equipment/process
required: false
schema:
type: string
- name: created
in: query
description: When Media was collected
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: Who/What this Media is a record of
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: Encounter associated with media
required: false
schema:
type: string
- name: type
in: query
description: "Classification of media as image, video, or audio"
required: false
schema:
type: string
- name: operator
in: query
description: The person who generated the image
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: site
in: query
description: Observed body part
required: false
schema:
type: string
- name: view
in: query
description: "Imaging view, e.g. Lateral or Antero-posterior"
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: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: patient
in: query
description: Who/What this Media is a record of
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: device
in: query
description: Observing Device
required: false
schema:
type: string
- name: status
in: query
description: preparation | in-progress | not-done | on-hold | stopped | completed
| entered-in-error | unknown
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:
- Media
summary: "create-type: Create a new Media instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Media"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Media/_history:
get:
tags:
- Media
summary: "type-history: Fetch the resource change history for all resources\
\ of type Media"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Media/{id}/_history:
get:
tags:
- Media
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Media"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Media/_search:
get:
tags:
- Media
summary: "search-type: Search for Media instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Identifier(s) for the image
required: false
schema:
type: string
- name: modality
in: query
description: The type of acquisition equipment/process
required: false
schema:
type: string
- name: created
in: query
description: When Media was collected
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: Who/What this Media is a record of
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: Encounter associated with media
required: false
schema:
type: string
- name: type
in: query
description: "Classification of media as image, video, or audio"
required: false
schema:
type: string
- name: operator
in: query
description: The person who generated the image
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: site
in: query
description: Observed body part
required: false
schema:
type: string
- name: view
in: query
description: "Imaging view, e.g. Lateral or Antero-posterior"
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: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: patient
in: query
description: Who/What this Media is a record of
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: device
in: query
description: Observing Device
required: false
schema:
type: string
- name: status
in: query
description: preparation | in-progress | not-done | on-hold | stopped | completed
| entered-in-error | unknown
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"
/Media/$validate:
get:
tags:
- Media
summary: "GET: /Media/$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:
- Media
summary: "POST: /Media/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Media",
"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"
/Media/{id}/$validate:
get:
tags:
- Media
summary: "GET: /Media/{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:
- Media
summary: "POST: /Media/{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": "Media",
"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"
/Media/{id}/$meta-delete:
post:
tags:
- Media
summary: "POST: /Media/{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"
/Media/{id}/$meta-add:
post:
tags:
- Media
summary: "POST: /Media/{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"
/Media/$meta:
get:
tags:
- Media
summary: "GET: /Media/$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:
- Media
summary: "POST: /Media/$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"
/Media/{id}/$meta:
get:
tags:
- Media
summary: "GET: /Media/{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:
- Media
summary: "POST: /Media/{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"
/Media/$expunge:
post:
tags:
- Media
summary: "POST: /Media/$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"
/Media/{id}/$expunge:
post:
tags:
- Media
summary: "POST: /Media/{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"
/Media/{id}/$diff:
get:
tags:
- Media
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:
- Media
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"
/Medication/{id}:
get:
tags:
- Medication
summary: "read-instance: Read Medication instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Medication
summary: "update-instance: Update an existing Medication instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Medication"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Medication
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Medication
summary: "instance-patch: Patch a resource instance of type Medication by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Medication/{id}/_history/{version_id}:
get:
tags:
- Medication
summary: "vread-instance: Read Medication instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Medication:
get:
tags:
- Medication
summary: "search-type: Search for Medication instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Returns medications with this external identifier
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: ingredient
in: query
description: Returns medications for this ingredient reference
required: false
schema:
type: string
- name: lot-number
in: query
description: Returns medications in a batch with this lot number
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: manufacturer
in: query
description: Returns medications made or sold for this manufacturer
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: ingredient-code
in: query
description: Returns medications for this ingredient code
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: form
in: query
description: Returns medications for a specific dose form
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: expiration-date
in: query
description: Returns medications in a batch with this expiration date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: status
in: query
description: Returns medications for this status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Medication
summary: "create-type: Create a new Medication instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Medication"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Medication/_history:
get:
tags:
- Medication
summary: "type-history: Fetch the resource change history for all resources\
\ of type Medication"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Medication/{id}/_history:
get:
tags:
- Medication
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Medication"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Medication/_search:
get:
tags:
- Medication
summary: "search-type: Search for Medication instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Returns medications with this external identifier
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: ingredient
in: query
description: Returns medications for this ingredient reference
required: false
schema:
type: string
- name: lot-number
in: query
description: Returns medications in a batch with this lot number
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: manufacturer
in: query
description: Returns medications made or sold for this manufacturer
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: ingredient-code
in: query
description: Returns medications for this ingredient code
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: form
in: query
description: Returns medications for a specific dose form
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: expiration-date
in: query
description: Returns medications in a batch with this expiration date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: status
in: query
description: Returns medications for this status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Medication/$validate:
get:
tags:
- Medication
summary: "GET: /Medication/$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:
- Medication
summary: "POST: /Medication/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Medication",
"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"
/Medication/{id}/$validate:
get:
tags:
- Medication
summary: "GET: /Medication/{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:
- Medication
summary: "POST: /Medication/{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": "Medication",
"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"
/Medication/{id}/$meta-delete:
post:
tags:
- Medication
summary: "POST: /Medication/{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"
/Medication/{id}/$meta-add:
post:
tags:
- Medication
summary: "POST: /Medication/{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"
/Medication/$meta:
get:
tags:
- Medication
summary: "GET: /Medication/$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:
- Medication
summary: "POST: /Medication/$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"
/Medication/{id}/$meta:
get:
tags:
- Medication
summary: "GET: /Medication/{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:
- Medication
summary: "POST: /Medication/{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"
/Medication/$expunge:
post:
tags:
- Medication
summary: "POST: /Medication/$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"
/Medication/{id}/$expunge:
post:
tags:
- Medication
summary: "POST: /Medication/{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"
/Medication/{id}/$diff:
get:
tags:
- Medication
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:
- Medication
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"
/MedicationAdministration/{id}:
get:
tags:
- MedicationAdministration
summary: "read-instance: Read MedicationAdministration instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicationAdministration
summary: "update-instance: Update an existing MedicationAdministration instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicationAdministration"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- MedicationAdministration
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- MedicationAdministration
summary: "instance-patch: Patch a resource instance of type MedicationAdministration\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationAdministration/{id}/_history/{version_id}:
get:
tags:
- MedicationAdministration
summary: "vread-instance: Read MedicationAdministration instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationAdministration:
get:
tags:
- MedicationAdministration
summary: "search-type: Search for MedicationAdministration instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: request
in: query
description: The identity of a request to list administrations from
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: performer
in: query
description: The identity of the individual who administered the medication
required: false
schema:
type: string
- name: subject
in: query
description: The identity of the individual or group to list administrations
for
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: medication
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication reference"
required: false
schema:
type: string
- name: reason-given
in: query
description: Reasons for administering the medication
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: effective-time
in: query
description: Date administration happened (or did not happen)
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: Return administrations that share this encounter or episode of
care
required: false
schema:
type: string
- name: reason-not-given
in: query
description: Reasons for not administering the medication
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: device
in: query
description: Return administrations with this administration device identity
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\
\n* [MedicationDispense](medicationdispense.html): Returns dispenses with\
\ a specified dispense status\r\n* [MedicationRequest](medicationrequest.html):\
\ Status of the prescription\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements that match the given status"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- MedicationAdministration
summary: "create-type: Create a new MedicationAdministration instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicationAdministration"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationAdministration/_history:
get:
tags:
- MedicationAdministration
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicationAdministration"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationAdministration/{id}/_history:
get:
tags:
- MedicationAdministration
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicationAdministration"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationAdministration/_search:
get:
tags:
- MedicationAdministration
summary: "search-type: Search for MedicationAdministration instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: request
in: query
description: The identity of a request to list administrations from
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: performer
in: query
description: The identity of the individual who administered the medication
required: false
schema:
type: string
- name: subject
in: query
description: The identity of the individual or group to list administrations
for
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: medication
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication reference"
required: false
schema:
type: string
- name: reason-given
in: query
description: Reasons for administering the medication
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: effective-time
in: query
description: Date administration happened (or did not happen)
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: Return administrations that share this encounter or episode of
care
required: false
schema:
type: string
- name: reason-not-given
in: query
description: Reasons for not administering the medication
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: device
in: query
description: Return administrations with this administration device identity
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\
\n* [MedicationDispense](medicationdispense.html): Returns dispenses with\
\ a specified dispense status\r\n* [MedicationRequest](medicationrequest.html):\
\ Status of the prescription\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements that match the given status"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationAdministration/$validate:
get:
tags:
- MedicationAdministration
summary: "GET: /MedicationAdministration/$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:
- MedicationAdministration
summary: "POST: /MedicationAdministration/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicationAdministration",
"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"
/MedicationAdministration/{id}/$validate:
get:
tags:
- MedicationAdministration
summary: "GET: /MedicationAdministration/{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:
- MedicationAdministration
summary: "POST: /MedicationAdministration/{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": "MedicationAdministration",
"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"
/MedicationAdministration/{id}/$meta-delete:
post:
tags:
- MedicationAdministration
summary: "POST: /MedicationAdministration/{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"
/MedicationAdministration/{id}/$meta-add:
post:
tags:
- MedicationAdministration
summary: "POST: /MedicationAdministration/{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"
/MedicationAdministration/$meta:
get:
tags:
- MedicationAdministration
summary: "GET: /MedicationAdministration/$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:
- MedicationAdministration
summary: "POST: /MedicationAdministration/$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"
/MedicationAdministration/{id}/$meta:
get:
tags:
- MedicationAdministration
summary: "GET: /MedicationAdministration/{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:
- MedicationAdministration
summary: "POST: /MedicationAdministration/{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"
/MedicationAdministration/$expunge:
post:
tags:
- MedicationAdministration
summary: "POST: /MedicationAdministration/$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"
/MedicationAdministration/{id}/$expunge:
post:
tags:
- MedicationAdministration
summary: "POST: /MedicationAdministration/{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"
/MedicationAdministration/{id}/$diff:
get:
tags:
- MedicationAdministration
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:
- MedicationAdministration
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"
/MedicationDispense/{id}:
get:
tags:
- MedicationDispense
summary: "read-instance: Read MedicationDispense instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicationDispense
summary: "update-instance: Update an existing MedicationDispense instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicationDispense"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- MedicationDispense
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- MedicationDispense
summary: "instance-patch: Patch a resource instance of type MedicationDispense\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationDispense/{id}/_history/{version_id}:
get:
tags:
- MedicationDispense
summary: "vread-instance: Read MedicationDispense instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationDispense:
get:
tags:
- MedicationDispense
summary: "search-type: Search for MedicationDispense instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: performer
in: query
description: Returns dispenses performed by a specific individual
required: false
schema:
type: string
- name: receiver
in: query
description: The identity of a receiver to list dispenses for
required: false
schema:
type: string
- name: subject
in: query
description: The identity of a patient for whom to list dispenses
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: destination
in: query
description: Returns dispenses that should be sent to a specific destination
required: false
schema:
type: string
- name: medication
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication reference"
required: false
schema:
type: string
- name: responsibleparty
in: query
description: Returns dispenses with the specified responsible party
required: false
schema:
type: string
- name: type
in: query
description: Returns dispenses of a specific type
required: false
schema:
type: string
- name: whenhandedover
in: query
description: Returns dispenses handed over on this date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: whenprepared
in: query
description: Returns dispenses prepared on this date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: prescription
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a prescription to list dispenses from"
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: Returns dispenses with a specific context (episode or episode
of care)
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* [MedicationAdministration](medicationadministration.html):\
\ MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\
\n* [MedicationDispense](medicationdispense.html): Returns dispenses with\
\ a specified dispense status\r\n* [MedicationRequest](medicationrequest.html):\
\ Status of the prescription\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements that match the given status"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- MedicationDispense
summary: "create-type: Create a new MedicationDispense instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicationDispense"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationDispense/_history:
get:
tags:
- MedicationDispense
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicationDispense"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationDispense/{id}/_history:
get:
tags:
- MedicationDispense
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicationDispense"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationDispense/_search:
get:
tags:
- MedicationDispense
summary: "search-type: Search for MedicationDispense instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: performer
in: query
description: Returns dispenses performed by a specific individual
required: false
schema:
type: string
- name: receiver
in: query
description: The identity of a receiver to list dispenses for
required: false
schema:
type: string
- name: subject
in: query
description: The identity of a patient for whom to list dispenses
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: destination
in: query
description: Returns dispenses that should be sent to a specific destination
required: false
schema:
type: string
- name: medication
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication reference"
required: false
schema:
type: string
- name: responsibleparty
in: query
description: Returns dispenses with the specified responsible party
required: false
schema:
type: string
- name: type
in: query
description: Returns dispenses of a specific type
required: false
schema:
type: string
- name: whenhandedover
in: query
description: Returns dispenses handed over on this date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: whenprepared
in: query
description: Returns dispenses prepared on this date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: prescription
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a prescription to list dispenses from"
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: Returns dispenses with a specific context (episode or episode
of care)
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* [MedicationAdministration](medicationadministration.html):\
\ MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\
\n* [MedicationDispense](medicationdispense.html): Returns dispenses with\
\ a specified dispense status\r\n* [MedicationRequest](medicationrequest.html):\
\ Status of the prescription\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements that match the given status"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationDispense/$validate:
get:
tags:
- MedicationDispense
summary: "GET: /MedicationDispense/$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:
- MedicationDispense
summary: "POST: /MedicationDispense/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicationDispense",
"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"
/MedicationDispense/{id}/$validate:
get:
tags:
- MedicationDispense
summary: "GET: /MedicationDispense/{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:
- MedicationDispense
summary: "POST: /MedicationDispense/{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": "MedicationDispense",
"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"
/MedicationDispense/{id}/$meta-delete:
post:
tags:
- MedicationDispense
summary: "POST: /MedicationDispense/{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"
/MedicationDispense/{id}/$meta-add:
post:
tags:
- MedicationDispense
summary: "POST: /MedicationDispense/{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"
/MedicationDispense/$meta:
get:
tags:
- MedicationDispense
summary: "GET: /MedicationDispense/$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:
- MedicationDispense
summary: "POST: /MedicationDispense/$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"
/MedicationDispense/{id}/$meta:
get:
tags:
- MedicationDispense
summary: "GET: /MedicationDispense/{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:
- MedicationDispense
summary: "POST: /MedicationDispense/{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"
/MedicationDispense/$expunge:
post:
tags:
- MedicationDispense
summary: "POST: /MedicationDispense/$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"
/MedicationDispense/{id}/$expunge:
post:
tags:
- MedicationDispense
summary: "POST: /MedicationDispense/{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"
/MedicationDispense/{id}/$diff:
get:
tags:
- MedicationDispense
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:
- MedicationDispense
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"
/MedicationKnowledge/{id}:
get:
tags:
- MedicationKnowledge
summary: "read-instance: Read MedicationKnowledge instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicationKnowledge
summary: "update-instance: Update an existing MedicationKnowledge instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicationKnowledge"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- MedicationKnowledge
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- MedicationKnowledge
summary: "instance-patch: Patch a resource instance of type MedicationKnowledge\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationKnowledge/{id}/_history/{version_id}:
get:
tags:
- MedicationKnowledge
summary: "vread-instance: Read MedicationKnowledge instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationKnowledge:
get:
tags:
- MedicationKnowledge
summary: "search-type: Search for MedicationKnowledge instances"
description: This is a search type
parameters:
- name: code
in: query
description: Code that identifies this medication
required: false
schema:
type: string
- name: ingredient
in: query
description: Medication(s) or substance(s) contained in the medication
required: false
schema:
type: string
- name: doseform
in: query
description: powder | tablets | capsule +
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: classification-type
in: query
description: "The type of category for the medication (for example, therapeutic\
\ classification, therapeutic sub-classification)"
required: false
schema:
type: string
- name: monograph-type
in: query
description: The category of medication document
required: false
schema:
type: string
- name: classification
in: query
description: Specific category assigned to the medication
required: false
schema:
type: string
- name: manufacturer
in: query
description: Manufacturer of the item
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: ingredient-code
in: query
description: Medication(s) or substance(s) contained in the medication
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: source-cost
in: query
description: The source or owner for the price information
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: monitoring-program-name
in: query
description: Name of the reviewing program
required: false
schema:
type: string
- name: monograph
in: query
description: Associated documentation about the medication
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: monitoring-program-type
in: query
description: Type of program under which the medication is monitored
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: active | inactive | entered-in-error
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:
- MedicationKnowledge
summary: "create-type: Create a new MedicationKnowledge instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicationKnowledge"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationKnowledge/_history:
get:
tags:
- MedicationKnowledge
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicationKnowledge"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationKnowledge/{id}/_history:
get:
tags:
- MedicationKnowledge
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicationKnowledge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationKnowledge/_search:
get:
tags:
- MedicationKnowledge
summary: "search-type: Search for MedicationKnowledge instances"
description: This is a search type
parameters:
- name: code
in: query
description: Code that identifies this medication
required: false
schema:
type: string
- name: ingredient
in: query
description: Medication(s) or substance(s) contained in the medication
required: false
schema:
type: string
- name: doseform
in: query
description: powder | tablets | capsule +
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: classification-type
in: query
description: "The type of category for the medication (for example, therapeutic\
\ classification, therapeutic sub-classification)"
required: false
schema:
type: string
- name: monograph-type
in: query
description: The category of medication document
required: false
schema:
type: string
- name: classification
in: query
description: Specific category assigned to the medication
required: false
schema:
type: string
- name: manufacturer
in: query
description: Manufacturer of the item
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: ingredient-code
in: query
description: Medication(s) or substance(s) contained in the medication
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: source-cost
in: query
description: The source or owner for the price information
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: monitoring-program-name
in: query
description: Name of the reviewing program
required: false
schema:
type: string
- name: monograph
in: query
description: Associated documentation about the medication
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: monitoring-program-type
in: query
description: Type of program under which the medication is monitored
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: active | inactive | entered-in-error
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"
/MedicationKnowledge/$validate:
get:
tags:
- MedicationKnowledge
summary: "GET: /MedicationKnowledge/$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:
- MedicationKnowledge
summary: "POST: /MedicationKnowledge/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicationKnowledge",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationKnowledge/{id}/$validate:
get:
tags:
- MedicationKnowledge
summary: "GET: /MedicationKnowledge/{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:
- MedicationKnowledge
summary: "POST: /MedicationKnowledge/{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": "MedicationKnowledge",
"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"
/MedicationKnowledge/{id}/$meta-delete:
post:
tags:
- MedicationKnowledge
summary: "POST: /MedicationKnowledge/{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"
/MedicationKnowledge/{id}/$meta-add:
post:
tags:
- MedicationKnowledge
summary: "POST: /MedicationKnowledge/{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"
/MedicationKnowledge/$meta:
get:
tags:
- MedicationKnowledge
summary: "GET: /MedicationKnowledge/$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:
- MedicationKnowledge
summary: "POST: /MedicationKnowledge/$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"
/MedicationKnowledge/{id}/$meta:
get:
tags:
- MedicationKnowledge
summary: "GET: /MedicationKnowledge/{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:
- MedicationKnowledge
summary: "POST: /MedicationKnowledge/{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"
/MedicationKnowledge/$expunge:
post:
tags:
- MedicationKnowledge
summary: "POST: /MedicationKnowledge/$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"
/MedicationKnowledge/{id}/$expunge:
post:
tags:
- MedicationKnowledge
summary: "POST: /MedicationKnowledge/{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"
/MedicationKnowledge/{id}/$diff:
get:
tags:
- MedicationKnowledge
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:
- MedicationKnowledge
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"
/MedicationRequest/{id}:
get:
tags:
- MedicationRequest
summary: "read-instance: Read MedicationRequest instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicationRequest
summary: "update-instance: Update an existing MedicationRequest instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicationRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- MedicationRequest
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- MedicationRequest
summary: "instance-patch: Patch a resource instance of type MedicationRequest\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationRequest/{id}/_history/{version_id}:
get:
tags:
- MedicationRequest
summary: "vread-instance: Read MedicationRequest instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationRequest:
get:
tags:
- MedicationRequest
summary: "search-type: Search for MedicationRequest instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns medication request to be administered on a specific date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: authoredon
in: query
description: Return prescriptions written on this date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: The identity of a patient to list orders for
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: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: intended-performer
in: query
description: Returns the intended performer of the administration of the medication
request
required: false
schema:
type: string
- name: intended-performertype
in: query
description: Returns requests for a specific type of performer
required: false
schema:
type: string
- name: requester
in: query
description: Returns prescriptions prescribed by this prescriber
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: intended-dispenser
in: query
description: Returns prescriptions intended to be dispensed by this Organization
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: medication
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication reference"
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: priority
in: query
description: Returns prescriptions with different priorities
required: false
schema:
type: string
- name: intent
in: query
description: Returns prescriptions with different intents
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: Returns prescriptions with different categories
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\
\n* [MedicationDispense](medicationdispense.html): Returns dispenses with\
\ a specified dispense status\r\n* [MedicationRequest](medicationrequest.html):\
\ Status of the prescription\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements that match the given status"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- MedicationRequest
summary: "create-type: Create a new MedicationRequest instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicationRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationRequest/_history:
get:
tags:
- MedicationRequest
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicationRequest"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationRequest/{id}/_history:
get:
tags:
- MedicationRequest
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicationRequest"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationRequest/_search:
get:
tags:
- MedicationRequest
summary: "search-type: Search for MedicationRequest instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns medication request to be administered on a specific date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: authoredon
in: query
description: Return prescriptions written on this date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: subject
in: query
description: The identity of a patient to list orders for
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: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: intended-performer
in: query
description: Returns the intended performer of the administration of the medication
request
required: false
schema:
type: string
- name: intended-performertype
in: query
description: Returns requests for a specific type of performer
required: false
schema:
type: string
- name: requester
in: query
description: Returns prescriptions prescribed by this prescriber
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: intended-dispenser
in: query
description: Returns prescriptions intended to be dispensed by this Organization
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: medication
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication reference"
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: priority
in: query
description: Returns prescriptions with different priorities
required: false
schema:
type: string
- name: intent
in: query
description: Returns prescriptions with different intents
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: Returns prescriptions with different categories
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\
\n* [MedicationDispense](medicationdispense.html): Returns dispenses with\
\ a specified dispense status\r\n* [MedicationRequest](medicationrequest.html):\
\ Status of the prescription\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements that match the given status"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationRequest/$validate:
get:
tags:
- MedicationRequest
summary: "GET: /MedicationRequest/$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:
- MedicationRequest
summary: "POST: /MedicationRequest/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicationRequest",
"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"
/MedicationRequest/{id}/$validate:
get:
tags:
- MedicationRequest
summary: "GET: /MedicationRequest/{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:
- MedicationRequest
summary: "POST: /MedicationRequest/{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": "MedicationRequest",
"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"
/MedicationRequest/{id}/$meta-delete:
post:
tags:
- MedicationRequest
summary: "POST: /MedicationRequest/{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"
/MedicationRequest/{id}/$meta-add:
post:
tags:
- MedicationRequest
summary: "POST: /MedicationRequest/{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"
/MedicationRequest/$meta:
get:
tags:
- MedicationRequest
summary: "GET: /MedicationRequest/$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:
- MedicationRequest
summary: "POST: /MedicationRequest/$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"
/MedicationRequest/{id}/$meta:
get:
tags:
- MedicationRequest
summary: "GET: /MedicationRequest/{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:
- MedicationRequest
summary: "POST: /MedicationRequest/{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"
/MedicationRequest/$expunge:
post:
tags:
- MedicationRequest
summary: "POST: /MedicationRequest/$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"
/MedicationRequest/{id}/$expunge:
post:
tags:
- MedicationRequest
summary: "POST: /MedicationRequest/{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"
/MedicationRequest/{id}/$diff:
get:
tags:
- MedicationRequest
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:
- MedicationRequest
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"
/MedicationStatement/{id}:
get:
tags:
- MedicationStatement
summary: "read-instance: Read MedicationStatement instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicationStatement
summary: "update-instance: Update an existing MedicationStatement 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": "MedicationStatement"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- MedicationStatement
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:
- MedicationStatement
summary: "instance-patch: Patch a resource instance of type MedicationStatement\
\ 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"
/MedicationStatement/{id}/_history/{version_id}:
get:
tags:
- MedicationStatement
summary: "vread-instance: Read MedicationStatement instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationStatement:
get:
tags:
- MedicationStatement
summary: "search-type: Search for MedicationStatement instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: subject
in: query
description: "The identity of a patient, animal or group to list statements\
\ for"
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: medication
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication reference"
required: false
schema:
type: string
- name: part-of
in: query
description: Returns statements that are part of another event.
required: false
schema:
type: string
- name: source
in: query
description: Who or where the information in the statement came from
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: effective
in: query
description: Date when patient was taking (or not taking) the medication
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: Returns statements for a specific context (episode or episode
of Care).
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: Returns statements of this category of medicationstatement
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\
\n* [MedicationDispense](medicationdispense.html): Returns dispenses with\
\ a specified dispense status\r\n* [MedicationRequest](medicationrequest.html):\
\ Status of the prescription\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements that match the given status"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- MedicationStatement
summary: "create-type: Create a new MedicationStatement instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicationStatement"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationStatement/_history:
get:
tags:
- MedicationStatement
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicationStatement"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationStatement/{id}/_history:
get:
tags:
- MedicationStatement
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicationStatement"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationStatement/_search:
get:
tags:
- MedicationStatement
summary: "search-type: Search for MedicationStatement instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: subject
in: query
description: "The identity of a patient, animal or group to list statements\
\ for"
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: medication
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication reference"
required: false
schema:
type: string
- name: part-of
in: query
description: Returns statements that are part of another event.
required: false
schema:
type: string
- name: source
in: query
description: Who or where the information in the statement came from
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: effective
in: query
description: Date when patient was taking (or not taking) the medication
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: Returns statements for a specific context (episode or episode
of Care).
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: Returns statements of this category of medicationstatement
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html):\
\ MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\
\n* [MedicationDispense](medicationdispense.html): Returns dispenses with\
\ a specified dispense status\r\n* [MedicationRequest](medicationrequest.html):\
\ Status of the prescription\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements that match the given status"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicationStatement/$validate:
get:
tags:
- MedicationStatement
summary: "GET: /MedicationStatement/$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:
- MedicationStatement
summary: "POST: /MedicationStatement/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicationStatement",
"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"
/MedicationStatement/{id}/$validate:
get:
tags:
- MedicationStatement
summary: "GET: /MedicationStatement/{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:
- MedicationStatement
summary: "POST: /MedicationStatement/{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": "MedicationStatement",
"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"
/MedicationStatement/{id}/$meta-delete:
post:
tags:
- MedicationStatement
summary: "POST: /MedicationStatement/{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"
/MedicationStatement/{id}/$meta-add:
post:
tags:
- MedicationStatement
summary: "POST: /MedicationStatement/{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"
/MedicationStatement/$meta:
get:
tags:
- MedicationStatement
summary: "GET: /MedicationStatement/$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:
- MedicationStatement
summary: "POST: /MedicationStatement/$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"
/MedicationStatement/{id}/$meta:
get:
tags:
- MedicationStatement
summary: "GET: /MedicationStatement/{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:
- MedicationStatement
summary: "POST: /MedicationStatement/{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"
/MedicationStatement/$expunge:
post:
tags:
- MedicationStatement
summary: "POST: /MedicationStatement/$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"
/MedicationStatement/{id}/$expunge:
post:
tags:
- MedicationStatement
summary: "POST: /MedicationStatement/{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"
/MedicationStatement/{id}/$diff:
get:
tags:
- MedicationStatement
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:
- MedicationStatement
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"
/MedicinalProduct/{id}:
get:
tags:
- MedicinalProduct
summary: "read-instance: Read MedicinalProduct instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicinalProduct
summary: "update-instance: Update an existing MedicinalProduct 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": "MedicinalProduct"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- MedicinalProduct
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:
- MedicinalProduct
summary: "instance-patch: Patch a resource instance of type MedicinalProduct\
\ 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"
/MedicinalProduct/{id}/_history/{version_id}:
get:
tags:
- MedicinalProduct
summary: "vread-instance: Read MedicinalProduct instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProduct:
get:
tags:
- MedicinalProduct
summary: "search-type: Search for MedicinalProduct instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: identifier
in: query
description: Business identifier for this product. Could be an MPID
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
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: _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: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: name
in: query
description: The full product name
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: name-language
in: query
description: Language code for this name
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- MedicinalProduct
summary: "create-type: Create a new MedicinalProduct instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicinalProduct"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProduct/_history:
get:
tags:
- MedicinalProduct
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicinalProduct"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProduct/{id}/_history:
get:
tags:
- MedicinalProduct
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicinalProduct"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProduct/_search:
get:
tags:
- MedicinalProduct
summary: "search-type: Search for MedicinalProduct instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: identifier
in: query
description: Business identifier for this product. Could be an MPID
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
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: _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: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: name
in: query
description: The full product name
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: name-language
in: query
description: Language code for this name
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProduct/$validate:
get:
tags:
- MedicinalProduct
summary: "GET: /MedicinalProduct/$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:
- MedicinalProduct
summary: "POST: /MedicinalProduct/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicinalProduct",
"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"
/MedicinalProduct/{id}/$validate:
get:
tags:
- MedicinalProduct
summary: "GET: /MedicinalProduct/{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:
- MedicinalProduct
summary: "POST: /MedicinalProduct/{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": "MedicinalProduct",
"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"
/MedicinalProduct/{id}/$meta-delete:
post:
tags:
- MedicinalProduct
summary: "POST: /MedicinalProduct/{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"
/MedicinalProduct/{id}/$meta-add:
post:
tags:
- MedicinalProduct
summary: "POST: /MedicinalProduct/{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"
/MedicinalProduct/$meta:
get:
tags:
- MedicinalProduct
summary: "GET: /MedicinalProduct/$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:
- MedicinalProduct
summary: "POST: /MedicinalProduct/$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"
/MedicinalProduct/{id}/$meta:
get:
tags:
- MedicinalProduct
summary: "GET: /MedicinalProduct/{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:
- MedicinalProduct
summary: "POST: /MedicinalProduct/{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"
/MedicinalProduct/$expunge:
post:
tags:
- MedicinalProduct
summary: "POST: /MedicinalProduct/$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"
/MedicinalProduct/{id}/$expunge:
post:
tags:
- MedicinalProduct
summary: "POST: /MedicinalProduct/{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"
/MedicinalProduct/{id}/$diff:
get:
tags:
- MedicinalProduct
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:
- MedicinalProduct
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"
/MedicinalProductAuthorization/{id}:
get:
tags:
- MedicinalProductAuthorization
summary: "read-instance: Read MedicinalProductAuthorization instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicinalProductAuthorization
summary: "update-instance: Update an existing MedicinalProductAuthorization\
\ 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": "MedicinalProductAuthorization"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- MedicinalProductAuthorization
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:
- MedicinalProductAuthorization
summary: "instance-patch: Patch a resource instance of type MedicinalProductAuthorization\
\ 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"
/MedicinalProductAuthorization/{id}/_history/{version_id}:
get:
tags:
- MedicinalProductAuthorization
summary: "vread-instance: Read MedicinalProductAuthorization instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductAuthorization:
get:
tags:
- MedicinalProductAuthorization
summary: "search-type: Search for MedicinalProductAuthorization instances"
description: This is a search type
parameters:
- name: country
in: query
description: The country in which the marketing authorization has been granted
required: false
schema:
type: string
- name: identifier
in: query
description: "Business identifier for the marketing authorization, as assigned\
\ by a regulator"
required: false
schema:
type: string
- name: subject
in: query
description: The medicinal product that is being authorized
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: holder
in: query
description: Marketing Authorization Holder
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 marketing authorization
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:
- MedicinalProductAuthorization
summary: "create-type: Create a new MedicinalProductAuthorization instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicinalProductAuthorization"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductAuthorization/_history:
get:
tags:
- MedicinalProductAuthorization
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicinalProductAuthorization"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductAuthorization/{id}/_history:
get:
tags:
- MedicinalProductAuthorization
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicinalProductAuthorization"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductAuthorization/_search:
get:
tags:
- MedicinalProductAuthorization
summary: "search-type: Search for MedicinalProductAuthorization instances"
description: This is a search type
parameters:
- name: country
in: query
description: The country in which the marketing authorization has been granted
required: false
schema:
type: string
- name: identifier
in: query
description: "Business identifier for the marketing authorization, as assigned\
\ by a regulator"
required: false
schema:
type: string
- name: subject
in: query
description: The medicinal product that is being authorized
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: holder
in: query
description: Marketing Authorization Holder
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 marketing authorization
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"
/MedicinalProductAuthorization/$validate:
get:
tags:
- MedicinalProductAuthorization
summary: "GET: /MedicinalProductAuthorization/$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:
- MedicinalProductAuthorization
summary: "POST: /MedicinalProductAuthorization/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicinalProductAuthorization",
"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"
/MedicinalProductAuthorization/{id}/$validate:
get:
tags:
- MedicinalProductAuthorization
summary: "GET: /MedicinalProductAuthorization/{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:
- MedicinalProductAuthorization
summary: "POST: /MedicinalProductAuthorization/{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": "MedicinalProductAuthorization",
"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"
/MedicinalProductAuthorization/{id}/$meta-delete:
post:
tags:
- MedicinalProductAuthorization
summary: "POST: /MedicinalProductAuthorization/{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"
/MedicinalProductAuthorization/{id}/$meta-add:
post:
tags:
- MedicinalProductAuthorization
summary: "POST: /MedicinalProductAuthorization/{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"
/MedicinalProductAuthorization/$meta:
get:
tags:
- MedicinalProductAuthorization
summary: "GET: /MedicinalProductAuthorization/$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:
- MedicinalProductAuthorization
summary: "POST: /MedicinalProductAuthorization/$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"
/MedicinalProductAuthorization/{id}/$meta:
get:
tags:
- MedicinalProductAuthorization
summary: "GET: /MedicinalProductAuthorization/{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:
- MedicinalProductAuthorization
summary: "POST: /MedicinalProductAuthorization/{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"
/MedicinalProductAuthorization/$expunge:
post:
tags:
- MedicinalProductAuthorization
summary: "POST: /MedicinalProductAuthorization/$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"
/MedicinalProductAuthorization/{id}/$expunge:
post:
tags:
- MedicinalProductAuthorization
summary: "POST: /MedicinalProductAuthorization/{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"
/MedicinalProductAuthorization/{id}/$diff:
get:
tags:
- MedicinalProductAuthorization
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:
- MedicinalProductAuthorization
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"
/MedicinalProductContraindication/{id}:
get:
tags:
- MedicinalProductContraindication
summary: "read-instance: Read MedicinalProductContraindication instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicinalProductContraindication
summary: "update-instance: Update an existing MedicinalProductContraindication\
\ 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": "MedicinalProductContraindication"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- MedicinalProductContraindication
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:
- MedicinalProductContraindication
summary: "instance-patch: Patch a resource instance of type MedicinalProductContraindication\
\ 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"
/MedicinalProductContraindication/{id}/_history/{version_id}:
get:
tags:
- MedicinalProductContraindication
summary: "vread-instance: Read MedicinalProductContraindication instance with\
\ specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductContraindication:
get:
tags:
- MedicinalProductContraindication
summary: "search-type: Search for MedicinalProductContraindication instances"
description: This is a search type
parameters:
- 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: subject
in: query
description: The medication for which this is an contraindication
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: _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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- MedicinalProductContraindication
summary: "create-type: Create a new MedicinalProductContraindication instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicinalProductContraindication"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductContraindication/_history:
get:
tags:
- MedicinalProductContraindication
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicinalProductContraindication"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductContraindication/{id}/_history:
get:
tags:
- MedicinalProductContraindication
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicinalProductContraindication"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductContraindication/_search:
get:
tags:
- MedicinalProductContraindication
summary: "search-type: Search for MedicinalProductContraindication instances"
description: This is a search type
parameters:
- 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: subject
in: query
description: The medication for which this is an contraindication
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: _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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/MedicinalProductContraindication/$validate:
get:
tags:
- MedicinalProductContraindication
summary: "GET: /MedicinalProductContraindication/$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:
- MedicinalProductContraindication
summary: "POST: /MedicinalProductContraindication/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicinalProductContraindication",
"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"
/MedicinalProductContraindication/{id}/$validate:
get:
tags:
- MedicinalProductContraindication
summary: "GET: /MedicinalProductContraindication/{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:
- MedicinalProductContraindication
summary: "POST: /MedicinalProductContraindication/{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": "MedicinalProductContraindication",
"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"
/MedicinalProductContraindication/{id}/$meta-delete:
post:
tags:
- MedicinalProductContraindication
summary: "POST: /MedicinalProductContraindication/{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"
/MedicinalProductContraindication/{id}/$meta-add:
post:
tags:
- MedicinalProductContraindication
summary: "POST: /MedicinalProductContraindication/{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"
/MedicinalProductContraindication/$meta:
get:
tags:
- MedicinalProductContraindication
summary: "GET: /MedicinalProductContraindication/$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:
- MedicinalProductContraindication
summary: "POST: /MedicinalProductContraindication/$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"
/MedicinalProductContraindication/{id}/$meta:
get:
tags:
- MedicinalProductContraindication
summary: "GET: /MedicinalProductContraindication/{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:
- MedicinalProductContraindication
summary: "POST: /MedicinalProductContraindication/{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"
/MedicinalProductContraindication/$expunge:
post:
tags:
- MedicinalProductContraindication
summary: "POST: /MedicinalProductContraindication/$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"
/MedicinalProductContraindication/{id}/$expunge:
post:
tags:
- MedicinalProductContraindication
summary: "POST: /MedicinalProductContraindication/{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"
/MedicinalProductContraindication/{id}/$diff:
get:
tags:
- MedicinalProductContraindication
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:
- MedicinalProductContraindication
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"
/MedicinalProductIndication/{id}:
get:
tags:
- MedicinalProductIndication
summary: "read-instance: Read MedicinalProductIndication instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicinalProductIndication
summary: "update-instance: Update an existing MedicinalProductIndication 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": "MedicinalProductIndication"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- MedicinalProductIndication
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:
- MedicinalProductIndication
summary: "instance-patch: Patch a resource instance of type MedicinalProductIndication\
\ 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"
/MedicinalProductIndication/{id}/_history/{version_id}:
get:
tags:
- MedicinalProductIndication
summary: "vread-instance: Read MedicinalProductIndication instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductIndication:
get:
tags:
- MedicinalProductIndication
summary: "search-type: Search for MedicinalProductIndication instances"
description: This is a search type
parameters:
- 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: subject
in: query
description: The medication for which this is an indication
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: _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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- MedicinalProductIndication
summary: "create-type: Create a new MedicinalProductIndication instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicinalProductIndication"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductIndication/_history:
get:
tags:
- MedicinalProductIndication
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicinalProductIndication"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductIndication/{id}/_history:
get:
tags:
- MedicinalProductIndication
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicinalProductIndication"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductIndication/_search:
get:
tags:
- MedicinalProductIndication
summary: "search-type: Search for MedicinalProductIndication instances"
description: This is a search type
parameters:
- 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: subject
in: query
description: The medication for which this is an indication
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: _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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/MedicinalProductIndication/$validate:
get:
tags:
- MedicinalProductIndication
summary: "GET: /MedicinalProductIndication/$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:
- MedicinalProductIndication
summary: "POST: /MedicinalProductIndication/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicinalProductIndication",
"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"
/MedicinalProductIndication/{id}/$validate:
get:
tags:
- MedicinalProductIndication
summary: "GET: /MedicinalProductIndication/{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:
- MedicinalProductIndication
summary: "POST: /MedicinalProductIndication/{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": "MedicinalProductIndication",
"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"
/MedicinalProductIndication/{id}/$meta-delete:
post:
tags:
- MedicinalProductIndication
summary: "POST: /MedicinalProductIndication/{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"
/MedicinalProductIndication/{id}/$meta-add:
post:
tags:
- MedicinalProductIndication
summary: "POST: /MedicinalProductIndication/{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"
/MedicinalProductIndication/$meta:
get:
tags:
- MedicinalProductIndication
summary: "GET: /MedicinalProductIndication/$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:
- MedicinalProductIndication
summary: "POST: /MedicinalProductIndication/$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"
/MedicinalProductIndication/{id}/$meta:
get:
tags:
- MedicinalProductIndication
summary: "GET: /MedicinalProductIndication/{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:
- MedicinalProductIndication
summary: "POST: /MedicinalProductIndication/{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"
/MedicinalProductIndication/$expunge:
post:
tags:
- MedicinalProductIndication
summary: "POST: /MedicinalProductIndication/$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"
/MedicinalProductIndication/{id}/$expunge:
post:
tags:
- MedicinalProductIndication
summary: "POST: /MedicinalProductIndication/{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"
/MedicinalProductIndication/{id}/$diff:
get:
tags:
- MedicinalProductIndication
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:
- MedicinalProductIndication
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"
/MedicinalProductIngredient/{id}:
get:
tags:
- MedicinalProductIngredient
summary: "read-instance: Read MedicinalProductIngredient instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicinalProductIngredient
summary: "update-instance: Update an existing MedicinalProductIngredient 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": "MedicinalProductIngredient"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- MedicinalProductIngredient
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:
- MedicinalProductIngredient
summary: "instance-patch: Patch a resource instance of type MedicinalProductIngredient\
\ 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"
/MedicinalProductIngredient/{id}/_history/{version_id}:
get:
tags:
- MedicinalProductIngredient
summary: "vread-instance: Read MedicinalProductIngredient instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductIngredient:
get:
tags:
- MedicinalProductIngredient
summary: "search-type: Search for MedicinalProductIngredient instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- MedicinalProductIngredient
summary: "create-type: Create a new MedicinalProductIngredient instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicinalProductIngredient"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductIngredient/_history:
get:
tags:
- MedicinalProductIngredient
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicinalProductIngredient"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductIngredient/{id}/_history:
get:
tags:
- MedicinalProductIngredient
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicinalProductIngredient"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductIngredient/_search:
get:
tags:
- MedicinalProductIngredient
summary: "search-type: Search for MedicinalProductIngredient instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/MedicinalProductIngredient/$validate:
get:
tags:
- MedicinalProductIngredient
summary: "GET: /MedicinalProductIngredient/$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:
- MedicinalProductIngredient
summary: "POST: /MedicinalProductIngredient/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicinalProductIngredient",
"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"
/MedicinalProductIngredient/{id}/$validate:
get:
tags:
- MedicinalProductIngredient
summary: "GET: /MedicinalProductIngredient/{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:
- MedicinalProductIngredient
summary: "POST: /MedicinalProductIngredient/{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": "MedicinalProductIngredient",
"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"
/MedicinalProductIngredient/{id}/$meta-delete:
post:
tags:
- MedicinalProductIngredient
summary: "POST: /MedicinalProductIngredient/{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"
/MedicinalProductIngredient/{id}/$meta-add:
post:
tags:
- MedicinalProductIngredient
summary: "POST: /MedicinalProductIngredient/{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"
/MedicinalProductIngredient/$meta:
get:
tags:
- MedicinalProductIngredient
summary: "GET: /MedicinalProductIngredient/$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:
- MedicinalProductIngredient
summary: "POST: /MedicinalProductIngredient/$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"
/MedicinalProductIngredient/{id}/$meta:
get:
tags:
- MedicinalProductIngredient
summary: "GET: /MedicinalProductIngredient/{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:
- MedicinalProductIngredient
summary: "POST: /MedicinalProductIngredient/{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"
/MedicinalProductIngredient/$expunge:
post:
tags:
- MedicinalProductIngredient
summary: "POST: /MedicinalProductIngredient/$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"
/MedicinalProductIngredient/{id}/$expunge:
post:
tags:
- MedicinalProductIngredient
summary: "POST: /MedicinalProductIngredient/{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"
/MedicinalProductIngredient/{id}/$diff:
get:
tags:
- MedicinalProductIngredient
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:
- MedicinalProductIngredient
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"
/MedicinalProductInteraction/{id}:
get:
tags:
- MedicinalProductInteraction
summary: "read-instance: Read MedicinalProductInteraction instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicinalProductInteraction
summary: "update-instance: Update an existing MedicinalProductInteraction 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": "MedicinalProductInteraction"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- MedicinalProductInteraction
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:
- MedicinalProductInteraction
summary: "instance-patch: Patch a resource instance of type MedicinalProductInteraction\
\ 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"
/MedicinalProductInteraction/{id}/_history/{version_id}:
get:
tags:
- MedicinalProductInteraction
summary: "vread-instance: Read MedicinalProductInteraction instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductInteraction:
get:
tags:
- MedicinalProductInteraction
summary: "search-type: Search for MedicinalProductInteraction instances"
description: This is a search type
parameters:
- 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: subject
in: query
description: The medication for which this is an interaction
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: _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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- MedicinalProductInteraction
summary: "create-type: Create a new MedicinalProductInteraction instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicinalProductInteraction"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductInteraction/_history:
get:
tags:
- MedicinalProductInteraction
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicinalProductInteraction"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductInteraction/{id}/_history:
get:
tags:
- MedicinalProductInteraction
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicinalProductInteraction"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductInteraction/_search:
get:
tags:
- MedicinalProductInteraction
summary: "search-type: Search for MedicinalProductInteraction instances"
description: This is a search type
parameters:
- 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: subject
in: query
description: The medication for which this is an interaction
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: _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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/MedicinalProductInteraction/$validate:
get:
tags:
- MedicinalProductInteraction
summary: "GET: /MedicinalProductInteraction/$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:
- MedicinalProductInteraction
summary: "POST: /MedicinalProductInteraction/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicinalProductInteraction",
"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"
/MedicinalProductInteraction/{id}/$validate:
get:
tags:
- MedicinalProductInteraction
summary: "GET: /MedicinalProductInteraction/{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:
- MedicinalProductInteraction
summary: "POST: /MedicinalProductInteraction/{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": "MedicinalProductInteraction",
"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"
/MedicinalProductInteraction/{id}/$meta-delete:
post:
tags:
- MedicinalProductInteraction
summary: "POST: /MedicinalProductInteraction/{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"
/MedicinalProductInteraction/{id}/$meta-add:
post:
tags:
- MedicinalProductInteraction
summary: "POST: /MedicinalProductInteraction/{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"
/MedicinalProductInteraction/$meta:
get:
tags:
- MedicinalProductInteraction
summary: "GET: /MedicinalProductInteraction/$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:
- MedicinalProductInteraction
summary: "POST: /MedicinalProductInteraction/$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"
/MedicinalProductInteraction/{id}/$meta:
get:
tags:
- MedicinalProductInteraction
summary: "GET: /MedicinalProductInteraction/{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:
- MedicinalProductInteraction
summary: "POST: /MedicinalProductInteraction/{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"
/MedicinalProductInteraction/$expunge:
post:
tags:
- MedicinalProductInteraction
summary: "POST: /MedicinalProductInteraction/$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"
/MedicinalProductInteraction/{id}/$expunge:
post:
tags:
- MedicinalProductInteraction
summary: "POST: /MedicinalProductInteraction/{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"
/MedicinalProductInteraction/{id}/$diff:
get:
tags:
- MedicinalProductInteraction
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:
- MedicinalProductInteraction
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"
/MedicinalProductManufactured/{id}:
get:
tags:
- MedicinalProductManufactured
summary: "read-instance: Read MedicinalProductManufactured instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicinalProductManufactured
summary: "update-instance: Update an existing MedicinalProductManufactured 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": "MedicinalProductManufactured"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- MedicinalProductManufactured
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:
- MedicinalProductManufactured
summary: "instance-patch: Patch a resource instance of type MedicinalProductManufactured\
\ 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"
/MedicinalProductManufactured/{id}/_history/{version_id}:
get:
tags:
- MedicinalProductManufactured
summary: "vread-instance: Read MedicinalProductManufactured instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductManufactured:
get:
tags:
- MedicinalProductManufactured
summary: "search-type: Search for MedicinalProductManufactured instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- MedicinalProductManufactured
summary: "create-type: Create a new MedicinalProductManufactured instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicinalProductManufactured"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductManufactured/_history:
get:
tags:
- MedicinalProductManufactured
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicinalProductManufactured"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductManufactured/{id}/_history:
get:
tags:
- MedicinalProductManufactured
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicinalProductManufactured"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductManufactured/_search:
get:
tags:
- MedicinalProductManufactured
summary: "search-type: Search for MedicinalProductManufactured instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/MedicinalProductManufactured/$validate:
get:
tags:
- MedicinalProductManufactured
summary: "GET: /MedicinalProductManufactured/$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:
- MedicinalProductManufactured
summary: "POST: /MedicinalProductManufactured/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicinalProductManufactured",
"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"
/MedicinalProductManufactured/{id}/$validate:
get:
tags:
- MedicinalProductManufactured
summary: "GET: /MedicinalProductManufactured/{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:
- MedicinalProductManufactured
summary: "POST: /MedicinalProductManufactured/{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": "MedicinalProductManufactured",
"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"
/MedicinalProductManufactured/{id}/$meta-delete:
post:
tags:
- MedicinalProductManufactured
summary: "POST: /MedicinalProductManufactured/{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"
/MedicinalProductManufactured/{id}/$meta-add:
post:
tags:
- MedicinalProductManufactured
summary: "POST: /MedicinalProductManufactured/{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"
/MedicinalProductManufactured/$meta:
get:
tags:
- MedicinalProductManufactured
summary: "GET: /MedicinalProductManufactured/$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:
- MedicinalProductManufactured
summary: "POST: /MedicinalProductManufactured/$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"
/MedicinalProductManufactured/{id}/$meta:
get:
tags:
- MedicinalProductManufactured
summary: "GET: /MedicinalProductManufactured/{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:
- MedicinalProductManufactured
summary: "POST: /MedicinalProductManufactured/{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"
/MedicinalProductManufactured/$expunge:
post:
tags:
- MedicinalProductManufactured
summary: "POST: /MedicinalProductManufactured/$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"
/MedicinalProductManufactured/{id}/$expunge:
post:
tags:
- MedicinalProductManufactured
summary: "POST: /MedicinalProductManufactured/{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"
/MedicinalProductManufactured/{id}/$diff:
get:
tags:
- MedicinalProductManufactured
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:
- MedicinalProductManufactured
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"
/MedicinalProductPackaged/{id}:
get:
tags:
- MedicinalProductPackaged
summary: "read-instance: Read MedicinalProductPackaged instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicinalProductPackaged
summary: "update-instance: Update an existing MedicinalProductPackaged 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": "MedicinalProductPackaged"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- MedicinalProductPackaged
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:
- MedicinalProductPackaged
summary: "instance-patch: Patch a resource instance of type MedicinalProductPackaged\
\ 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"
/MedicinalProductPackaged/{id}/_history/{version_id}:
get:
tags:
- MedicinalProductPackaged
summary: "vread-instance: Read MedicinalProductPackaged instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductPackaged:
get:
tags:
- MedicinalProductPackaged
summary: "search-type: Search for MedicinalProductPackaged instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: identifier
in: query
description: Unique identifier
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: subject
in: query
description: The product with this is a pack for
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: _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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- MedicinalProductPackaged
summary: "create-type: Create a new MedicinalProductPackaged instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicinalProductPackaged"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductPackaged/_history:
get:
tags:
- MedicinalProductPackaged
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicinalProductPackaged"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductPackaged/{id}/_history:
get:
tags:
- MedicinalProductPackaged
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicinalProductPackaged"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductPackaged/_search:
get:
tags:
- MedicinalProductPackaged
summary: "search-type: Search for MedicinalProductPackaged instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: identifier
in: query
description: Unique identifier
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: subject
in: query
description: The product with this is a pack for
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: _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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/MedicinalProductPackaged/$validate:
get:
tags:
- MedicinalProductPackaged
summary: "GET: /MedicinalProductPackaged/$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:
- MedicinalProductPackaged
summary: "POST: /MedicinalProductPackaged/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicinalProductPackaged",
"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"
/MedicinalProductPackaged/{id}/$validate:
get:
tags:
- MedicinalProductPackaged
summary: "GET: /MedicinalProductPackaged/{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:
- MedicinalProductPackaged
summary: "POST: /MedicinalProductPackaged/{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": "MedicinalProductPackaged",
"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"
/MedicinalProductPackaged/{id}/$meta-delete:
post:
tags:
- MedicinalProductPackaged
summary: "POST: /MedicinalProductPackaged/{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"
/MedicinalProductPackaged/{id}/$meta-add:
post:
tags:
- MedicinalProductPackaged
summary: "POST: /MedicinalProductPackaged/{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"
/MedicinalProductPackaged/$meta:
get:
tags:
- MedicinalProductPackaged
summary: "GET: /MedicinalProductPackaged/$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:
- MedicinalProductPackaged
summary: "POST: /MedicinalProductPackaged/$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"
/MedicinalProductPackaged/{id}/$meta:
get:
tags:
- MedicinalProductPackaged
summary: "GET: /MedicinalProductPackaged/{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:
- MedicinalProductPackaged
summary: "POST: /MedicinalProductPackaged/{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"
/MedicinalProductPackaged/$expunge:
post:
tags:
- MedicinalProductPackaged
summary: "POST: /MedicinalProductPackaged/$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"
/MedicinalProductPackaged/{id}/$expunge:
post:
tags:
- MedicinalProductPackaged
summary: "POST: /MedicinalProductPackaged/{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"
/MedicinalProductPackaged/{id}/$diff:
get:
tags:
- MedicinalProductPackaged
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:
- MedicinalProductPackaged
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"
/MedicinalProductPharmaceutical/{id}:
get:
tags:
- MedicinalProductPharmaceutical
summary: "read-instance: Read MedicinalProductPharmaceutical instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicinalProductPharmaceutical
summary: "update-instance: Update an existing MedicinalProductPharmaceutical\
\ 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": "MedicinalProductPharmaceutical"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- MedicinalProductPharmaceutical
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:
- MedicinalProductPharmaceutical
summary: "instance-patch: Patch a resource instance of type MedicinalProductPharmaceutical\
\ 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"
/MedicinalProductPharmaceutical/{id}/_history/{version_id}:
get:
tags:
- MedicinalProductPharmaceutical
summary: "vread-instance: Read MedicinalProductPharmaceutical instance with\
\ specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductPharmaceutical:
get:
tags:
- MedicinalProductPharmaceutical
summary: "search-type: Search for MedicinalProductPharmaceutical instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: identifier
in: query
description: An identifier for the pharmaceutical medicinal product
required: false
schema:
type: string
- name: route
in: query
description: Coded expression for the route
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
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: _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: _security
in: query
description: Security Labels applied to this resource
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: target-species
in: query
description: Coded expression for the species
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- MedicinalProductPharmaceutical
summary: "create-type: Create a new MedicinalProductPharmaceutical instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicinalProductPharmaceutical"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductPharmaceutical/_history:
get:
tags:
- MedicinalProductPharmaceutical
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicinalProductPharmaceutical"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductPharmaceutical/{id}/_history:
get:
tags:
- MedicinalProductPharmaceutical
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicinalProductPharmaceutical"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductPharmaceutical/_search:
get:
tags:
- MedicinalProductPharmaceutical
summary: "search-type: Search for MedicinalProductPharmaceutical instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: identifier
in: query
description: An identifier for the pharmaceutical medicinal product
required: false
schema:
type: string
- name: route
in: query
description: Coded expression for the route
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
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: _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: _security
in: query
description: Security Labels applied to this resource
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: target-species
in: query
description: Coded expression for the species
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductPharmaceutical/$validate:
get:
tags:
- MedicinalProductPharmaceutical
summary: "GET: /MedicinalProductPharmaceutical/$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:
- MedicinalProductPharmaceutical
summary: "POST: /MedicinalProductPharmaceutical/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicinalProductPharmaceutical",
"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"
/MedicinalProductPharmaceutical/{id}/$validate:
get:
tags:
- MedicinalProductPharmaceutical
summary: "GET: /MedicinalProductPharmaceutical/{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:
- MedicinalProductPharmaceutical
summary: "POST: /MedicinalProductPharmaceutical/{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": "MedicinalProductPharmaceutical",
"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"
/MedicinalProductPharmaceutical/{id}/$meta-delete:
post:
tags:
- MedicinalProductPharmaceutical
summary: "POST: /MedicinalProductPharmaceutical/{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"
/MedicinalProductPharmaceutical/{id}/$meta-add:
post:
tags:
- MedicinalProductPharmaceutical
summary: "POST: /MedicinalProductPharmaceutical/{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"
/MedicinalProductPharmaceutical/$meta:
get:
tags:
- MedicinalProductPharmaceutical
summary: "GET: /MedicinalProductPharmaceutical/$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:
- MedicinalProductPharmaceutical
summary: "POST: /MedicinalProductPharmaceutical/$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"
/MedicinalProductPharmaceutical/{id}/$meta:
get:
tags:
- MedicinalProductPharmaceutical
summary: "GET: /MedicinalProductPharmaceutical/{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:
- MedicinalProductPharmaceutical
summary: "POST: /MedicinalProductPharmaceutical/{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"
/MedicinalProductPharmaceutical/$expunge:
post:
tags:
- MedicinalProductPharmaceutical
summary: "POST: /MedicinalProductPharmaceutical/$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"
/MedicinalProductPharmaceutical/{id}/$expunge:
post:
tags:
- MedicinalProductPharmaceutical
summary: "POST: /MedicinalProductPharmaceutical/{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"
/MedicinalProductPharmaceutical/{id}/$diff:
get:
tags:
- MedicinalProductPharmaceutical
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:
- MedicinalProductPharmaceutical
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"
/MedicinalProductUndesirableEffect/{id}:
get:
tags:
- MedicinalProductUndesirableEffect
summary: "read-instance: Read MedicinalProductUndesirableEffect instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MedicinalProductUndesirableEffect
summary: "update-instance: Update an existing MedicinalProductUndesirableEffect\
\ 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": "MedicinalProductUndesirableEffect"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- MedicinalProductUndesirableEffect
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:
- MedicinalProductUndesirableEffect
summary: "instance-patch: Patch a resource instance of type MedicinalProductUndesirableEffect\
\ 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"
/MedicinalProductUndesirableEffect/{id}/_history/{version_id}:
get:
tags:
- MedicinalProductUndesirableEffect
summary: "vread-instance: Read MedicinalProductUndesirableEffect instance with\
\ specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductUndesirableEffect:
get:
tags:
- MedicinalProductUndesirableEffect
summary: "search-type: Search for MedicinalProductUndesirableEffect instances"
description: This is a search type
parameters:
- 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: subject
in: query
description: The medication for which this is an undesirable effect
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: _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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- MedicinalProductUndesirableEffect
summary: "create-type: Create a new MedicinalProductUndesirableEffect instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MedicinalProductUndesirableEffect"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductUndesirableEffect/_history:
get:
tags:
- MedicinalProductUndesirableEffect
summary: "type-history: Fetch the resource change history for all resources\
\ of type MedicinalProductUndesirableEffect"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductUndesirableEffect/{id}/_history:
get:
tags:
- MedicinalProductUndesirableEffect
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MedicinalProductUndesirableEffect"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MedicinalProductUndesirableEffect/_search:
get:
tags:
- MedicinalProductUndesirableEffect
summary: "search-type: Search for MedicinalProductUndesirableEffect instances"
description: This is a search type
parameters:
- 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: subject
in: query
description: The medication for which this is an undesirable effect
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: _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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/MedicinalProductUndesirableEffect/$validate:
get:
tags:
- MedicinalProductUndesirableEffect
summary: "GET: /MedicinalProductUndesirableEffect/$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:
- MedicinalProductUndesirableEffect
summary: "POST: /MedicinalProductUndesirableEffect/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MedicinalProductUndesirableEffect",
"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"
/MedicinalProductUndesirableEffect/{id}/$validate:
get:
tags:
- MedicinalProductUndesirableEffect
summary: "GET: /MedicinalProductUndesirableEffect/{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:
- MedicinalProductUndesirableEffect
summary: "POST: /MedicinalProductUndesirableEffect/{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": "MedicinalProductUndesirableEffect",
"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"
/MedicinalProductUndesirableEffect/{id}/$meta-delete:
post:
tags:
- MedicinalProductUndesirableEffect
summary: "POST: /MedicinalProductUndesirableEffect/{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"
/MedicinalProductUndesirableEffect/{id}/$meta-add:
post:
tags:
- MedicinalProductUndesirableEffect
summary: "POST: /MedicinalProductUndesirableEffect/{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"
/MedicinalProductUndesirableEffect/$meta:
get:
tags:
- MedicinalProductUndesirableEffect
summary: "GET: /MedicinalProductUndesirableEffect/$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:
- MedicinalProductUndesirableEffect
summary: "POST: /MedicinalProductUndesirableEffect/$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"
/MedicinalProductUndesirableEffect/{id}/$meta:
get:
tags:
- MedicinalProductUndesirableEffect
summary: "GET: /MedicinalProductUndesirableEffect/{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:
- MedicinalProductUndesirableEffect
summary: "POST: /MedicinalProductUndesirableEffect/{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"
/MedicinalProductUndesirableEffect/$expunge:
post:
tags:
- MedicinalProductUndesirableEffect
summary: "POST: /MedicinalProductUndesirableEffect/$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"
/MedicinalProductUndesirableEffect/{id}/$expunge:
post:
tags:
- MedicinalProductUndesirableEffect
summary: "POST: /MedicinalProductUndesirableEffect/{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"
/MedicinalProductUndesirableEffect/{id}/$diff:
get:
tags:
- MedicinalProductUndesirableEffect
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:
- MedicinalProductUndesirableEffect
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"
/MessageDefinition/{id}:
get:
tags:
- MessageDefinition
summary: "read-instance: Read MessageDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MessageDefinition
summary: "update-instance: Update an existing MessageDefinition instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MessageDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- MessageDefinition
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- MessageDefinition
summary: "instance-patch: Patch a resource instance of type MessageDefinition\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MessageDefinition/{id}/_history/{version_id}:
get:
tags:
- MessageDefinition
summary: "vread-instance: Read MessageDefinition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MessageDefinition:
get:
tags:
- MessageDefinition
summary: "search-type: Search for MessageDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: parent
in: query
description: A resource that is the parent of the definition
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: focus
in: query
description: A resource that is a permitted focus of the message
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: event
in: query
description: The event that triggers the message or link to the event definition.
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\
\ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\
\ External identifier for the structure map\r\n* [ValueSet](valueset.html):\
\ External identifier for the value set"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: category
in: query
description: The behavior associated with the message
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- MessageDefinition
summary: "create-type: Create a new MessageDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MessageDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MessageDefinition/_history:
get:
tags:
- MessageDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type MessageDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MessageDefinition/{id}/_history:
get:
tags:
- MessageDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MessageDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MessageDefinition/_search:
get:
tags:
- MessageDefinition
summary: "search-type: Search for MessageDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: parent
in: query
description: A resource that is the parent of the definition
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: focus
in: query
description: A resource that is a permitted focus of the message
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: event
in: query
description: The event that triggers the message or link to the event definition.
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\
\ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\
\ External identifier for the structure map\r\n* [ValueSet](valueset.html):\
\ External identifier for the value set"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: category
in: query
description: The behavior associated with the message
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MessageDefinition/$validate:
get:
tags:
- MessageDefinition
summary: "GET: /MessageDefinition/$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:
- MessageDefinition
summary: "POST: /MessageDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MessageDefinition",
"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"
/MessageDefinition/{id}/$validate:
get:
tags:
- MessageDefinition
summary: "GET: /MessageDefinition/{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:
- MessageDefinition
summary: "POST: /MessageDefinition/{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": "MessageDefinition",
"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"
/MessageDefinition/{id}/$meta-delete:
post:
tags:
- MessageDefinition
summary: "POST: /MessageDefinition/{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"
/MessageDefinition/{id}/$meta-add:
post:
tags:
- MessageDefinition
summary: "POST: /MessageDefinition/{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"
/MessageDefinition/$meta:
get:
tags:
- MessageDefinition
summary: "GET: /MessageDefinition/$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:
- MessageDefinition
summary: "POST: /MessageDefinition/$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"
/MessageDefinition/{id}/$meta:
get:
tags:
- MessageDefinition
summary: "GET: /MessageDefinition/{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:
- MessageDefinition
summary: "POST: /MessageDefinition/{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"
/MessageDefinition/$expunge:
post:
tags:
- MessageDefinition
summary: "POST: /MessageDefinition/$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"
/MessageDefinition/{id}/$expunge:
post:
tags:
- MessageDefinition
summary: "POST: /MessageDefinition/{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"
/MessageDefinition/{id}/$diff:
get:
tags:
- MessageDefinition
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:
- MessageDefinition
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"
/MessageHeader/{id}:
get:
tags:
- MessageHeader
summary: "read-instance: Read MessageHeader instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MessageHeader
summary: "update-instance: Update an existing MessageHeader instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MessageHeader"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- MessageHeader
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- MessageHeader
summary: "instance-patch: Patch a resource instance of type MessageHeader by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MessageHeader/{id}/_history/{version_id}:
get:
tags:
- MessageHeader
summary: "vread-instance: Read MessageHeader instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MessageHeader:
get:
tags:
- MessageHeader
summary: "search-type: Search for MessageHeader instances"
description: This is a search type
parameters:
- name: code
in: query
description: ok | transient-error | fatal-error
required: false
schema:
type: string
- name: receiver
in: query
description: Intended "real-world" recipient for the data
required: false
schema:
type: string
- name: author
in: query
description: The source of the decision
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: destination
in: query
description: Name of system
required: false
schema:
type: string
- name: focus
in: query
description: The actual content of the message
required: false
schema:
type: string
- name: source
in: query
description: Name of system
required: false
schema:
type: string
- name: target
in: query
description: Particular delivery destination within the destination
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: destination-uri
in: query
description: Actual destination address or id
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: sender
in: query
description: Real world sender of the message
required: false
schema:
type: string
- name: source-uri
in: query
description: Actual message source address or id
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: responsible
in: query
description: Final responsibility for event
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: enterer
in: query
description: The source of the data entry
required: false
schema:
type: string
- name: response-id
in: query
description: Id of original message
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: event
in: query
description: Code for the event this message represents or link to event definition
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:
- MessageHeader
summary: "create-type: Create a new MessageHeader instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MessageHeader"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MessageHeader/_history:
get:
tags:
- MessageHeader
summary: "type-history: Fetch the resource change history for all resources\
\ of type MessageHeader"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MessageHeader/{id}/_history:
get:
tags:
- MessageHeader
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MessageHeader"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MessageHeader/_search:
get:
tags:
- MessageHeader
summary: "search-type: Search for MessageHeader instances"
description: This is a search type
parameters:
- name: code
in: query
description: ok | transient-error | fatal-error
required: false
schema:
type: string
- name: receiver
in: query
description: Intended "real-world" recipient for the data
required: false
schema:
type: string
- name: author
in: query
description: The source of the decision
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: destination
in: query
description: Name of system
required: false
schema:
type: string
- name: focus
in: query
description: The actual content of the message
required: false
schema:
type: string
- name: source
in: query
description: Name of system
required: false
schema:
type: string
- name: target
in: query
description: Particular delivery destination within the destination
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: destination-uri
in: query
description: Actual destination address or id
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: sender
in: query
description: Real world sender of the message
required: false
schema:
type: string
- name: source-uri
in: query
description: Actual message source address or id
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: responsible
in: query
description: Final responsibility for event
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: enterer
in: query
description: The source of the data entry
required: false
schema:
type: string
- name: response-id
in: query
description: Id of original message
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: event
in: query
description: Code for the event this message represents or link to event definition
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"
/MessageHeader/$validate:
get:
tags:
- MessageHeader
summary: "GET: /MessageHeader/$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:
- MessageHeader
summary: "POST: /MessageHeader/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MessageHeader",
"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"
/MessageHeader/{id}/$validate:
get:
tags:
- MessageHeader
summary: "GET: /MessageHeader/{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:
- MessageHeader
summary: "POST: /MessageHeader/{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": "MessageHeader",
"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"
/MessageHeader/{id}/$meta-delete:
post:
tags:
- MessageHeader
summary: "POST: /MessageHeader/{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"
/MessageHeader/{id}/$meta-add:
post:
tags:
- MessageHeader
summary: "POST: /MessageHeader/{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"
/MessageHeader/$meta:
get:
tags:
- MessageHeader
summary: "GET: /MessageHeader/$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:
- MessageHeader
summary: "POST: /MessageHeader/$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"
/MessageHeader/{id}/$meta:
get:
tags:
- MessageHeader
summary: "GET: /MessageHeader/{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:
- MessageHeader
summary: "POST: /MessageHeader/{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"
/MessageHeader/$expunge:
post:
tags:
- MessageHeader
summary: "POST: /MessageHeader/$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"
/MessageHeader/{id}/$expunge:
post:
tags:
- MessageHeader
summary: "POST: /MessageHeader/{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"
/MessageHeader/{id}/$diff:
get:
tags:
- MessageHeader
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:
- MessageHeader
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"
/MolecularSequence/{id}:
get:
tags:
- MolecularSequence
summary: "read-instance: Read MolecularSequence instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- MolecularSequence
summary: "update-instance: Update an existing MolecularSequence instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MolecularSequence"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- MolecularSequence
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- MolecularSequence
summary: "instance-patch: Patch a resource instance of type MolecularSequence\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MolecularSequence/{id}/_history/{version_id}:
get:
tags:
- MolecularSequence
summary: "vread-instance: Read MolecularSequence instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MolecularSequence:
get:
tags:
- MolecularSequence
summary: "search-type: Search for MolecularSequence instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The unique identity for a particular sequence
required: false
schema:
type: string
- name: referenceseqid-variant-coordinate
in: query
description: "Search parameter by reference sequence and variant coordinate.\
\ This will refer to part of a locus or part of a gene where search region\
\ will be represented in 1-based system. Since the coordinateSystem can\
\ either be 0-based or 1-based, this search query will include the result\
\ of both coordinateSystem that contains the equivalent segment of the gene\
\ or whole genome sequence. For example, a search for sequence can be represented\
\ as `referenceSeqId-variant-coordinate=NC_000001.11$lt345$gt123`, this\
\ means it will search for the MolecularSequence resource with variants\
\ on NC_000001.11 and with position >123 and <345, where in 1-based system\
\ resource, all strings within region NC_000001.11:124-344 will be revealed,\
\ while in 0-based system resource, all strings within region NC_000001.11:123-344\
\ will be revealed. You may want to check detail about 0-based v.s. 1-based\
\ above."
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: chromosome
in: query
description: Chromosome number of the reference sequence
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: Amino Acid Sequence/ DNA Sequence / RNA Sequence
required: false
schema:
type: string
- name: window-end
in: query
description: "End position (0-based exclusive, which menas the acid at this\
\ position will not be included, 1-based inclusive, which means the acid\
\ at this position will be included) of the reference sequence."
required: false
schema:
type: number
- name: window-start
in: query
description: "Start position (0-based inclusive, 1-based inclusive, that means\
\ the nucleic acid or amino acid at this position will be included) of the\
\ reference sequence."
required: false
schema:
type: number
- name: variant-end
in: query
description: "End position (0-based exclusive, which menas the acid at this\
\ position will not be included, 1-based inclusive, which means the acid\
\ at this position will be included) of the variant."
required: false
schema:
type: number
- 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: chromosome-variant-coordinate
in: query
description: "Search parameter by chromosome and variant coordinate. This\
\ will refer to part of a locus or part of a gene where search region will\
\ be represented in 1-based system. Since the coordinateSystem can either\
\ be 0-based or 1-based, this search query will include the result of both\
\ coordinateSystem that contains the equivalent segment of the gene or whole\
\ genome sequence. For example, a search for sequence can be represented\
\ as `chromosome-variant-coordinate=1$lt345$gt123`, this means it will search\
\ for the MolecularSequence resource with variants on chromosome 1 and with\
\ position >123 and <345, where in 1-based system resource, all strings\
\ within region 1:124-344 will be revealed, while in 0-based system resource,\
\ all strings within region 1:123-344 will be revealed. You may want to\
\ check detail about 0-based v.s. 1-based above."
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 subject that the observation is about
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: variant-start
in: query
description: "Start position (0-based inclusive, 1-based inclusive, that means\
\ the nucleic acid or amino acid at this position will be included) of the\
\ variant."
required: false
schema:
type: number
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: chromosome-window-coordinate
in: query
description: "Search parameter by chromosome and window. This will refer to\
\ part of a locus or part of a gene where search region will be represented\
\ in 1-based system. Since the coordinateSystem can either be 0-based or\
\ 1-based, this search query will include the result of both coordinateSystem\
\ that contains the equivalent segment of the gene or whole genome sequence.\
\ For example, a search for sequence can be represented as `chromosome-window-coordinate=1$lt345$gt123`,\
\ this means it will search for the MolecularSequence resource with a window\
\ on chromosome 1 and with position >123 and <345, where in 1-based system\
\ resource, all strings within region 1:124-344 will be revealed, while\
\ in 0-based system resource, all strings within region 1:123-344 will be\
\ revealed. You may want to check detail about 0-based v.s. 1-based above."
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: referenceseqid-window-coordinate
in: query
description: "Search parameter by reference sequence and window. This will\
\ refer to part of a locus or part of a gene where search region will be\
\ represented in 1-based system. Since the coordinateSystem can either be\
\ 0-based or 1-based, this search query will include the result of both\
\ coordinateSystem that contains the equivalent segment of the gene or whole\
\ genome sequence. For example, a search for sequence can be represented\
\ as `referenceSeqId-window-coordinate=NC_000001.11$lt345$gt123`, this means\
\ it will search for the MolecularSequence resource with a window on NC_000001.11\
\ and with position >123 and <345, where in 1-based system resource, all\
\ strings within region NC_000001.11:124-344 will be revealed, while in\
\ 0-based system resource, all strings within region NC_000001.11:123-344\
\ will be revealed. You may want to check detail about 0-based v.s. 1-based\
\ above."
required: false
schema:
type: string
- name: referenceseqid
in: query
description: Reference Sequence of the sequence
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:
- MolecularSequence
summary: "create-type: Create a new MolecularSequence instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "MolecularSequence"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MolecularSequence/_history:
get:
tags:
- MolecularSequence
summary: "type-history: Fetch the resource change history for all resources\
\ of type MolecularSequence"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MolecularSequence/{id}/_history:
get:
tags:
- MolecularSequence
summary: "instance-history: Fetch the resource change history for all resources\
\ of type MolecularSequence"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/MolecularSequence/_search:
get:
tags:
- MolecularSequence
summary: "search-type: Search for MolecularSequence instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The unique identity for a particular sequence
required: false
schema:
type: string
- name: referenceseqid-variant-coordinate
in: query
description: "Search parameter by reference sequence and variant coordinate.\
\ This will refer to part of a locus or part of a gene where search region\
\ will be represented in 1-based system. Since the coordinateSystem can\
\ either be 0-based or 1-based, this search query will include the result\
\ of both coordinateSystem that contains the equivalent segment of the gene\
\ or whole genome sequence. For example, a search for sequence can be represented\
\ as `referenceSeqId-variant-coordinate=NC_000001.11$lt345$gt123`, this\
\ means it will search for the MolecularSequence resource with variants\
\ on NC_000001.11 and with position >123 and <345, where in 1-based system\
\ resource, all strings within region NC_000001.11:124-344 will be revealed,\
\ while in 0-based system resource, all strings within region NC_000001.11:123-344\
\ will be revealed. You may want to check detail about 0-based v.s. 1-based\
\ above."
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: chromosome
in: query
description: Chromosome number of the reference sequence
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: Amino Acid Sequence/ DNA Sequence / RNA Sequence
required: false
schema:
type: string
- name: window-end
in: query
description: "End position (0-based exclusive, which menas the acid at this\
\ position will not be included, 1-based inclusive, which means the acid\
\ at this position will be included) of the reference sequence."
required: false
schema:
type: number
- name: window-start
in: query
description: "Start position (0-based inclusive, 1-based inclusive, that means\
\ the nucleic acid or amino acid at this position will be included) of the\
\ reference sequence."
required: false
schema:
type: number
- name: variant-end
in: query
description: "End position (0-based exclusive, which menas the acid at this\
\ position will not be included, 1-based inclusive, which means the acid\
\ at this position will be included) of the variant."
required: false
schema:
type: number
- 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: chromosome-variant-coordinate
in: query
description: "Search parameter by chromosome and variant coordinate. This\
\ will refer to part of a locus or part of a gene where search region will\
\ be represented in 1-based system. Since the coordinateSystem can either\
\ be 0-based or 1-based, this search query will include the result of both\
\ coordinateSystem that contains the equivalent segment of the gene or whole\
\ genome sequence. For example, a search for sequence can be represented\
\ as `chromosome-variant-coordinate=1$lt345$gt123`, this means it will search\
\ for the MolecularSequence resource with variants on chromosome 1 and with\
\ position >123 and <345, where in 1-based system resource, all strings\
\ within region 1:124-344 will be revealed, while in 0-based system resource,\
\ all strings within region 1:123-344 will be revealed. You may want to\
\ check detail about 0-based v.s. 1-based above."
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 subject that the observation is about
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: variant-start
in: query
description: "Start position (0-based inclusive, 1-based inclusive, that means\
\ the nucleic acid or amino acid at this position will be included) of the\
\ variant."
required: false
schema:
type: number
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: chromosome-window-coordinate
in: query
description: "Search parameter by chromosome and window. This will refer to\
\ part of a locus or part of a gene where search region will be represented\
\ in 1-based system. Since the coordinateSystem can either be 0-based or\
\ 1-based, this search query will include the result of both coordinateSystem\
\ that contains the equivalent segment of the gene or whole genome sequence.\
\ For example, a search for sequence can be represented as `chromosome-window-coordinate=1$lt345$gt123`,\
\ this means it will search for the MolecularSequence resource with a window\
\ on chromosome 1 and with position >123 and <345, where in 1-based system\
\ resource, all strings within region 1:124-344 will be revealed, while\
\ in 0-based system resource, all strings within region 1:123-344 will be\
\ revealed. You may want to check detail about 0-based v.s. 1-based above."
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: referenceseqid-window-coordinate
in: query
description: "Search parameter by reference sequence and window. This will\
\ refer to part of a locus or part of a gene where search region will be\
\ represented in 1-based system. Since the coordinateSystem can either be\
\ 0-based or 1-based, this search query will include the result of both\
\ coordinateSystem that contains the equivalent segment of the gene or whole\
\ genome sequence. For example, a search for sequence can be represented\
\ as `referenceSeqId-window-coordinate=NC_000001.11$lt345$gt123`, this means\
\ it will search for the MolecularSequence resource with a window on NC_000001.11\
\ and with position >123 and <345, where in 1-based system resource, all\
\ strings within region NC_000001.11:124-344 will be revealed, while in\
\ 0-based system resource, all strings within region NC_000001.11:123-344\
\ will be revealed. You may want to check detail about 0-based v.s. 1-based\
\ above."
required: false
schema:
type: string
- name: referenceseqid
in: query
description: Reference Sequence of the sequence
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"
/MolecularSequence/$validate:
get:
tags:
- MolecularSequence
summary: "GET: /MolecularSequence/$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:
- MolecularSequence
summary: "POST: /MolecularSequence/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "MolecularSequence",
"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"
/MolecularSequence/{id}/$validate:
get:
tags:
- MolecularSequence
summary: "GET: /MolecularSequence/{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:
- MolecularSequence
summary: "POST: /MolecularSequence/{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": "MolecularSequence",
"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"
/MolecularSequence/{id}/$meta-delete:
post:
tags:
- MolecularSequence
summary: "POST: /MolecularSequence/{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"
/MolecularSequence/{id}/$meta-add:
post:
tags:
- MolecularSequence
summary: "POST: /MolecularSequence/{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"
/MolecularSequence/$meta:
get:
tags:
- MolecularSequence
summary: "GET: /MolecularSequence/$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:
- MolecularSequence
summary: "POST: /MolecularSequence/$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"
/MolecularSequence/{id}/$meta:
get:
tags:
- MolecularSequence
summary: "GET: /MolecularSequence/{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:
- MolecularSequence
summary: "POST: /MolecularSequence/{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"
/MolecularSequence/$expunge:
post:
tags:
- MolecularSequence
summary: "POST: /MolecularSequence/$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"
/MolecularSequence/{id}/$expunge:
post:
tags:
- MolecularSequence
summary: "POST: /MolecularSequence/{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"
/MolecularSequence/{id}/$diff:
get:
tags:
- MolecularSequence
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:
- MolecularSequence
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"
/NamingSystem/{id}:
get:
tags:
- NamingSystem
summary: "read-instance: Read NamingSystem instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- NamingSystem
summary: "update-instance: Update an existing NamingSystem instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "NamingSystem"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- NamingSystem
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- NamingSystem
summary: "instance-patch: Patch a resource instance of type NamingSystem by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/NamingSystem/{id}/_history/{version_id}:
get:
tags:
- NamingSystem
summary: "vread-instance: Read NamingSystem instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/NamingSystem:
get:
tags:
- NamingSystem
summary: "search-type: Search for NamingSystem instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: type
in: query
description: "e.g. driver, provider, patient, bank etc."
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: contact
in: query
description: Name of an individual to contact
required: false
schema:
type: string
- name: responsible
in: query
description: Who maintains system namespace?
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: telecom
in: query
description: Contact details for individual or organization
required: false
schema:
type: string
- name: value
in: query
description: The unique identifier
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: period
in: query
description: When is identifier valid?
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: kind
in: query
description: codesystem | identifier | root
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: id-type
in: query
description: oid | uuid | uri | other
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* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- NamingSystem
summary: "create-type: Create a new NamingSystem instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "NamingSystem"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/NamingSystem/_history:
get:
tags:
- NamingSystem
summary: "type-history: Fetch the resource change history for all resources\
\ of type NamingSystem"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/NamingSystem/{id}/_history:
get:
tags:
- NamingSystem
summary: "instance-history: Fetch the resource change history for all resources\
\ of type NamingSystem"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/NamingSystem/_search:
get:
tags:
- NamingSystem
summary: "search-type: Search for NamingSystem instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: type
in: query
description: "e.g. driver, provider, patient, bank etc."
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: contact
in: query
description: Name of an individual to contact
required: false
schema:
type: string
- name: responsible
in: query
description: Who maintains system namespace?
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: telecom
in: query
description: Contact details for individual or organization
required: false
schema:
type: string
- name: value
in: query
description: The unique identifier
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: period
in: query
description: When is identifier valid?
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: kind
in: query
description: codesystem | identifier | root
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: id-type
in: query
description: oid | uuid | uri | other
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* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/NamingSystem/$validate:
get:
tags:
- NamingSystem
summary: "GET: /NamingSystem/$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:
- NamingSystem
summary: "POST: /NamingSystem/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "NamingSystem",
"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"
/NamingSystem/{id}/$validate:
get:
tags:
- NamingSystem
summary: "GET: /NamingSystem/{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:
- NamingSystem
summary: "POST: /NamingSystem/{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": "NamingSystem",
"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"
/NamingSystem/{id}/$meta-delete:
post:
tags:
- NamingSystem
summary: "POST: /NamingSystem/{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"
/NamingSystem/{id}/$meta-add:
post:
tags:
- NamingSystem
summary: "POST: /NamingSystem/{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"
/NamingSystem/$meta:
get:
tags:
- NamingSystem
summary: "GET: /NamingSystem/$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:
- NamingSystem
summary: "POST: /NamingSystem/$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"
/NamingSystem/{id}/$meta:
get:
tags:
- NamingSystem
summary: "GET: /NamingSystem/{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:
- NamingSystem
summary: "POST: /NamingSystem/{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"
/NamingSystem/$expunge:
post:
tags:
- NamingSystem
summary: "POST: /NamingSystem/$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"
/NamingSystem/{id}/$expunge:
post:
tags:
- NamingSystem
summary: "POST: /NamingSystem/{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"
/NamingSystem/{id}/$diff:
get:
tags:
- NamingSystem
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:
- NamingSystem
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"
/NutritionOrder/{id}:
get:
tags:
- NutritionOrder
summary: "read-instance: Read NutritionOrder instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- NutritionOrder
summary: "update-instance: Update an existing NutritionOrder instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "NutritionOrder"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- NutritionOrder
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- NutritionOrder
summary: "instance-patch: Patch a resource instance of type NutritionOrder by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/NutritionOrder/{id}/_history/{version_id}:
get:
tags:
- NutritionOrder
summary: "vread-instance: Read NutritionOrder instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/NutritionOrder:
get:
tags:
- NutritionOrder
summary: "search-type: Search for NutritionOrder instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
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: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: oraldiet
in: query
description: "Type of diet that can be consumed orally (i.e., take via the\
\ mouth)."
required: false
schema:
type: string
- name: additive
in: query
description: Type of module component to add to the feeding
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: datetime
in: query
description: Return nutrition orders requested on this date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: provider
in: query
description: The identity of the provider who placed the nutrition order
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: supplement
in: query
description: Type of supplement product requested
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: formula
in: query
description: Type of enteral or infant formula
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
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 nutrition order.
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:
- NutritionOrder
summary: "create-type: Create a new NutritionOrder instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "NutritionOrder"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/NutritionOrder/_history:
get:
tags:
- NutritionOrder
summary: "type-history: Fetch the resource change history for all resources\
\ of type NutritionOrder"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/NutritionOrder/{id}/_history:
get:
tags:
- NutritionOrder
summary: "instance-history: Fetch the resource change history for all resources\
\ of type NutritionOrder"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/NutritionOrder/_search:
get:
tags:
- NutritionOrder
summary: "search-type: Search for NutritionOrder instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
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: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: oraldiet
in: query
description: "Type of diet that can be consumed orally (i.e., take via the\
\ mouth)."
required: false
schema:
type: string
- name: additive
in: query
description: Type of module component to add to the feeding
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: datetime
in: query
description: Return nutrition orders requested on this date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: provider
in: query
description: The identity of the provider who placed the nutrition order
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: supplement
in: query
description: Type of supplement product requested
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: formula
in: query
description: Type of enteral or infant formula
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
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 nutrition order.
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"
/NutritionOrder/$validate:
get:
tags:
- NutritionOrder
summary: "GET: /NutritionOrder/$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:
- NutritionOrder
summary: "POST: /NutritionOrder/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "NutritionOrder",
"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"
/NutritionOrder/{id}/$validate:
get:
tags:
- NutritionOrder
summary: "GET: /NutritionOrder/{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:
- NutritionOrder
summary: "POST: /NutritionOrder/{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": "NutritionOrder",
"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"
/NutritionOrder/{id}/$meta-delete:
post:
tags:
- NutritionOrder
summary: "POST: /NutritionOrder/{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"
/NutritionOrder/{id}/$meta-add:
post:
tags:
- NutritionOrder
summary: "POST: /NutritionOrder/{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"
/NutritionOrder/$meta:
get:
tags:
- NutritionOrder
summary: "GET: /NutritionOrder/$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:
- NutritionOrder
summary: "POST: /NutritionOrder/$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"
/NutritionOrder/{id}/$meta:
get:
tags:
- NutritionOrder
summary: "GET: /NutritionOrder/{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:
- NutritionOrder
summary: "POST: /NutritionOrder/{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"
/NutritionOrder/$expunge:
post:
tags:
- NutritionOrder
summary: "POST: /NutritionOrder/$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"
/NutritionOrder/{id}/$expunge:
post:
tags:
- NutritionOrder
summary: "POST: /NutritionOrder/{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"
/NutritionOrder/{id}/$diff:
get:
tags:
- NutritionOrder
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:
- NutritionOrder
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"
/Observation/{id}:
get:
tags:
- Observation
summary: "read-instance: Read Observation instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Observation
summary: "update-instance: Update an existing Observation instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Observation"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Observation
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Observation
summary: "instance-patch: Patch a resource instance of type Observation by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Observation/{id}/_history/{version_id}:
get:
tags:
- Observation
summary: "vread-instance: Read Observation instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Observation:
get:
tags:
- Observation
summary: "search-type: Search for Observation instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: combo-data-absent-reason
in: query
description: "The reason why the expected value in the element Observation.value[x]\
\ or Observation.component.value[x] is missing."
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: component-data-absent-reason
in: query
description: "The reason why the expected value in the element Observation.component.value[x]\
\ is missing."
required: false
schema:
type: string
- name: subject
in: query
description: The subject that the observation is about
required: false
schema:
type: string
- name: combo-code-value-quantity
in: query
description: "Code and quantity value parameter pair, including in components"
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: value-concept
in: query
description: "The value of the observation, if the value is a CodeableConcept"
required: false
schema:
type: string
- name: value-date
in: query
description: "The value of the observation, if the value is a date or period\
\ of time"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: derived-from
in: query
description: Related measurements the observation is made from
required: false
schema:
type: string
- name: focus
in: query
description: The focus of an observation when the focus is not the patient
of record.
required: false
schema:
type: string
- name: part-of
in: query
description: Part of referenced event
required: false
schema:
type: string
- name: has-member
in: query
description: Related resource that belongs to the Observation group
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: code-value-string
in: query
description: Code and string value parameter pair
required: false
schema:
type: string
- name: component-code-value-quantity
in: query
description: Component code and component quantity value parameter pair
required: false
schema:
type: string
- name: based-on
in: query
description: Reference to the service request.
required: false
schema:
type: string
- name: code-value-date
in: query
description: Code and date/time value parameter pair
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: specimen
in: query
description: Specimen used for this observation
required: false
schema:
type: string
- name: component-code
in: query
description: The component code of the observation type
required: false
schema:
type: string
- name: code-value-quantity
in: query
description: Code and quantity value parameter pair
required: false
schema:
type: string
- name: combo-code-value-concept
in: query
description: "Code and coded value parameter pair, including in components"
required: false
schema:
type: string
- name: value-string
in: query
description: "The value of the observation, if the value is a string, and\
\ also searches in CodeableConcept.text"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: performer
in: query
description: Who performed the observation
required: false
schema:
type: string
- name: combo-code
in: query
description: The code of the observation type or component type
required: false
schema:
type: string
- name: method
in: query
description: The method used for the observation
required: false
schema:
type: string
- name: value-quantity
in: query
description: "The value of the observation, if the value is a Quantity, or\
\ a SampledData (just search on the bounds of the values in sampled data)"
required: false
schema:
anyOf:
- type: string
- type: number
- name: component-value-quantity
in: query
description: "The value of the component observation, if the value is a Quantity,\
\ or a SampledData (just search on the bounds of the values in sampled data)"
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: data-absent-reason
in: query
description: "The reason why the expected value in the element Observation.value[x]\
\ is missing."
required: false
schema:
type: string
- name: combo-value-quantity
in: query
description: "The value or component value of the observation, if the value\
\ is a Quantity, or a SampledData (just search on the bounds of the values\
\ in sampled data)"
required: false
schema:
anyOf:
- type: string
- type: number
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
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: code-value-concept
in: query
description: Code and coded value parameter pair
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: component-code-value-concept
in: query
description: Component code and component coded value parameter pair
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: component-value-concept
in: query
description: "The value of the component observation, if the value is a CodeableConcept"
required: false
schema:
type: string
- name: category
in: query
description: The classification of the type of observation
required: false
schema:
type: string
- name: device
in: query
description: The Device that generated the observation data.
required: false
schema:
type: string
- name: combo-value-concept
in: query
description: "The value or component value of the observation, if the value\
\ is a CodeableConcept"
required: false
schema:
type: string
- name: status
in: query
description: The status of the observation
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:
- Observation
summary: "create-type: Create a new Observation instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Observation"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Observation/_history:
get:
tags:
- Observation
summary: "type-history: Fetch the resource change history for all resources\
\ of type Observation"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Observation/{id}/_history:
get:
tags:
- Observation
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Observation"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Observation/_search:
get:
tags:
- Observation
summary: "search-type: Search for Observation instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: combo-data-absent-reason
in: query
description: "The reason why the expected value in the element Observation.value[x]\
\ or Observation.component.value[x] is missing."
required: false
schema:
type: string
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: component-data-absent-reason
in: query
description: "The reason why the expected value in the element Observation.component.value[x]\
\ is missing."
required: false
schema:
type: string
- name: subject
in: query
description: The subject that the observation is about
required: false
schema:
type: string
- name: combo-code-value-quantity
in: query
description: "Code and quantity value parameter pair, including in components"
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: value-concept
in: query
description: "The value of the observation, if the value is a CodeableConcept"
required: false
schema:
type: string
- name: value-date
in: query
description: "The value of the observation, if the value is a date or period\
\ of time"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: derived-from
in: query
description: Related measurements the observation is made from
required: false
schema:
type: string
- name: focus
in: query
description: The focus of an observation when the focus is not the patient
of record.
required: false
schema:
type: string
- name: part-of
in: query
description: Part of referenced event
required: false
schema:
type: string
- name: has-member
in: query
description: Related resource that belongs to the Observation group
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: code-value-string
in: query
description: Code and string value parameter pair
required: false
schema:
type: string
- name: component-code-value-quantity
in: query
description: Component code and component quantity value parameter pair
required: false
schema:
type: string
- name: based-on
in: query
description: Reference to the service request.
required: false
schema:
type: string
- name: code-value-date
in: query
description: Code and date/time value parameter pair
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: specimen
in: query
description: Specimen used for this observation
required: false
schema:
type: string
- name: component-code
in: query
description: The component code of the observation type
required: false
schema:
type: string
- name: code-value-quantity
in: query
description: Code and quantity value parameter pair
required: false
schema:
type: string
- name: combo-code-value-concept
in: query
description: "Code and coded value parameter pair, including in components"
required: false
schema:
type: string
- name: value-string
in: query
description: "The value of the observation, if the value is a string, and\
\ also searches in CodeableConcept.text"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: performer
in: query
description: Who performed the observation
required: false
schema:
type: string
- name: combo-code
in: query
description: The code of the observation type or component type
required: false
schema:
type: string
- name: method
in: query
description: The method used for the observation
required: false
schema:
type: string
- name: value-quantity
in: query
description: "The value of the observation, if the value is a Quantity, or\
\ a SampledData (just search on the bounds of the values in sampled data)"
required: false
schema:
anyOf:
- type: string
- type: number
- name: component-value-quantity
in: query
description: "The value of the component observation, if the value is a Quantity,\
\ or a SampledData (just search on the bounds of the values in sampled data)"
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: data-absent-reason
in: query
description: "The reason why the expected value in the element Observation.value[x]\
\ is missing."
required: false
schema:
type: string
- name: combo-value-quantity
in: query
description: "The value or component value of the observation, if the value\
\ is a Quantity, or a SampledData (just search on the bounds of the values\
\ in sampled data)"
required: false
schema:
anyOf:
- type: string
- type: number
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
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: code-value-concept
in: query
description: Code and coded value parameter pair
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: component-code-value-concept
in: query
description: Component code and component coded value parameter pair
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: component-value-concept
in: query
description: "The value of the component observation, if the value is a CodeableConcept"
required: false
schema:
type: string
- name: category
in: query
description: The classification of the type of observation
required: false
schema:
type: string
- name: device
in: query
description: The Device that generated the observation data.
required: false
schema:
type: string
- name: combo-value-concept
in: query
description: "The value or component value of the observation, if the value\
\ is a CodeableConcept"
required: false
schema:
type: string
- name: status
in: query
description: The status of the observation
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"
/Observation/$validate:
get:
tags:
- Observation
summary: "GET: /Observation/$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:
- Observation
summary: "POST: /Observation/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Observation",
"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"
/Observation/{id}/$validate:
get:
tags:
- Observation
summary: "GET: /Observation/{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:
- Observation
summary: "POST: /Observation/{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": "Observation",
"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"
/Observation/{id}/$meta-delete:
post:
tags:
- Observation
summary: "POST: /Observation/{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"
/Observation/{id}/$meta-add:
post:
tags:
- Observation
summary: "POST: /Observation/{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"
/Observation/$meta:
get:
tags:
- Observation
summary: "GET: /Observation/$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:
- Observation
summary: "POST: /Observation/$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"
/Observation/{id}/$meta:
get:
tags:
- Observation
summary: "GET: /Observation/{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:
- Observation
summary: "POST: /Observation/{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"
/Observation/$expunge:
post:
tags:
- Observation
summary: "POST: /Observation/$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"
/Observation/{id}/$expunge:
post:
tags:
- Observation
summary: "POST: /Observation/{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"
/Observation/$lastn:
get:
tags:
- Observation
summary: "GET: /Observation/$lastn"
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: category
in: query
description: The classification of the type of observation
required: false
schema:
type: string
- name: code
in: query
description: The code of the observation type
required: false
schema:
type: string
- name: date
in: query
description: The effective date of the observation
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: patient
in: query
description: The subject that the observation is about (if patient)
required: false
schema:
type: string
- name: subject
in: query
description: The subject that the observation is about
required: false
schema:
type: string
- name: max
in: query
description: The maximum number of observations to return for each observation
code
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:
- Observation
summary: "POST: /Observation/$lastn"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "_count"
}, {
"name": "category",
"valueString": "example"
}, {
"name": "code",
"valueString": "example"
}, {
"name": "date",
"valueString": "example"
}, {
"name": "patient",
"valueString": "example"
}, {
"name": "subject",
"valueString": "example"
}, {
"name": "max",
"valueInteger": 0
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Observation/{id}/$diff:
get:
tags:
- Observation
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:
- Observation
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"
/ObservationDefinition/{id}:
get:
tags:
- ObservationDefinition
summary: "read-instance: Read ObservationDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ObservationDefinition
summary: "update-instance: Update an existing ObservationDefinition instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ObservationDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- ObservationDefinition
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- ObservationDefinition
summary: "instance-patch: Patch a resource instance of type ObservationDefinition\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ObservationDefinition/{id}/_history/{version_id}:
get:
tags:
- ObservationDefinition
summary: "vread-instance: Read ObservationDefinition instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ObservationDefinition:
get:
tags:
- ObservationDefinition
summary: "search-type: Search for ObservationDefinition instances"
description: This is a search type
parameters:
- name: _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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- ObservationDefinition
summary: "create-type: Create a new ObservationDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ObservationDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ObservationDefinition/_history:
get:
tags:
- ObservationDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type ObservationDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ObservationDefinition/{id}/_history:
get:
tags:
- ObservationDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ObservationDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ObservationDefinition/_search:
get:
tags:
- ObservationDefinition
summary: "search-type: Search for ObservationDefinition instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/ObservationDefinition/$validate:
get:
tags:
- ObservationDefinition
summary: "GET: /ObservationDefinition/$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:
- ObservationDefinition
summary: "POST: /ObservationDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ObservationDefinition",
"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"
/ObservationDefinition/{id}/$validate:
get:
tags:
- ObservationDefinition
summary: "GET: /ObservationDefinition/{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:
- ObservationDefinition
summary: "POST: /ObservationDefinition/{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": "ObservationDefinition",
"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"
/ObservationDefinition/{id}/$meta-delete:
post:
tags:
- ObservationDefinition
summary: "POST: /ObservationDefinition/{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"
/ObservationDefinition/{id}/$meta-add:
post:
tags:
- ObservationDefinition
summary: "POST: /ObservationDefinition/{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"
/ObservationDefinition/$meta:
get:
tags:
- ObservationDefinition
summary: "GET: /ObservationDefinition/$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:
- ObservationDefinition
summary: "POST: /ObservationDefinition/$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"
/ObservationDefinition/{id}/$meta:
get:
tags:
- ObservationDefinition
summary: "GET: /ObservationDefinition/{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:
- ObservationDefinition
summary: "POST: /ObservationDefinition/{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"
/ObservationDefinition/$expunge:
post:
tags:
- ObservationDefinition
summary: "POST: /ObservationDefinition/$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"
/ObservationDefinition/{id}/$expunge:
post:
tags:
- ObservationDefinition
summary: "POST: /ObservationDefinition/{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"
/ObservationDefinition/{id}/$diff:
get:
tags:
- ObservationDefinition
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:
- ObservationDefinition
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OperationDefinition/{id}:
get:
tags:
- OperationDefinition
summary: "read-instance: Read OperationDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- OperationDefinition
summary: "update-instance: Update an existing OperationDefinition instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "OperationDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- OperationDefinition
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- OperationDefinition
summary: "instance-patch: Patch a resource instance of type OperationDefinition\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OperationDefinition/{id}/_history/{version_id}:
get:
tags:
- OperationDefinition
summary: "vread-instance: Read OperationDefinition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OperationDefinition:
get:
tags:
- OperationDefinition
summary: "search-type: Search for OperationDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: Name used to invoke the operation
required: false
schema:
type: string
- name: instance
in: query
description: Invoke on an instance?
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: type
in: query
description: Invoke at the type level?
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: output-profile
in: query
description: Validation information for out parameters
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: kind
in: query
description: operation | query
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: input-profile
in: query
description: Validation information for in parameters
required: false
schema:
type: string
- name: system
in: query
description: Invoke at the system level?
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
- name: base
in: query
description: Marks this as a profile of the base
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- OperationDefinition
summary: "create-type: Create a new OperationDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "OperationDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OperationDefinition/_history:
get:
tags:
- OperationDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type OperationDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OperationDefinition/{id}/_history:
get:
tags:
- OperationDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type OperationDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OperationDefinition/_search:
get:
tags:
- OperationDefinition
summary: "search-type: Search for OperationDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: Name used to invoke the operation
required: false
schema:
type: string
- name: instance
in: query
description: Invoke on an instance?
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: type
in: query
description: Invoke at the type level?
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: output-profile
in: query
description: Validation information for out parameters
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: kind
in: query
description: operation | query
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: input-profile
in: query
description: Validation information for in parameters
required: false
schema:
type: string
- name: system
in: query
description: Invoke at the system level?
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
- name: base
in: query
description: Marks this as a profile of the base
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"
/OperationDefinition/$validate:
get:
tags:
- OperationDefinition
summary: "GET: /OperationDefinition/$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:
- OperationDefinition
summary: "POST: /OperationDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "OperationDefinition",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OperationDefinition/{id}/$validate:
get:
tags:
- OperationDefinition
summary: "GET: /OperationDefinition/{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:
- OperationDefinition
summary: "POST: /OperationDefinition/{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": "OperationDefinition",
"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"
/OperationDefinition/{id}/$meta-delete:
post:
tags:
- OperationDefinition
summary: "POST: /OperationDefinition/{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"
/OperationDefinition/{id}/$meta-add:
post:
tags:
- OperationDefinition
summary: "POST: /OperationDefinition/{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"
/OperationDefinition/$meta:
get:
tags:
- OperationDefinition
summary: "GET: /OperationDefinition/$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:
- OperationDefinition
summary: "POST: /OperationDefinition/$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"
/OperationDefinition/{id}/$meta:
get:
tags:
- OperationDefinition
summary: "GET: /OperationDefinition/{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:
- OperationDefinition
summary: "POST: /OperationDefinition/{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"
/OperationDefinition/$expunge:
post:
tags:
- OperationDefinition
summary: "POST: /OperationDefinition/$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"
/OperationDefinition/{id}/$expunge:
post:
tags:
- OperationDefinition
summary: "POST: /OperationDefinition/{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"
/OperationDefinition/{id}/$diff:
get:
tags:
- OperationDefinition
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- OperationDefinition
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OperationOutcome/{id}:
get:
tags:
- OperationOutcome
summary: "read-instance: Read OperationOutcome instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- OperationOutcome
summary: "update-instance: Update an existing OperationOutcome instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "OperationOutcome"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- OperationOutcome
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- OperationOutcome
summary: "instance-patch: Patch a resource instance of type OperationOutcome\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OperationOutcome/{id}/_history/{version_id}:
get:
tags:
- OperationOutcome
summary: "vread-instance: Read OperationOutcome instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OperationOutcome:
get:
tags:
- OperationOutcome
summary: "search-type: Search for OperationOutcome instances"
description: This is a search type
parameters:
- name: _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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- OperationOutcome
summary: "create-type: Create a new OperationOutcome instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "OperationOutcome"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OperationOutcome/_history:
get:
tags:
- OperationOutcome
summary: "type-history: Fetch the resource change history for all resources\
\ of type OperationOutcome"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OperationOutcome/{id}/_history:
get:
tags:
- OperationOutcome
summary: "instance-history: Fetch the resource change history for all resources\
\ of type OperationOutcome"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OperationOutcome/_search:
get:
tags:
- OperationOutcome
summary: "search-type: Search for OperationOutcome instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/OperationOutcome/$validate:
get:
tags:
- OperationOutcome
summary: "GET: /OperationOutcome/$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:
- OperationOutcome
summary: "POST: /OperationOutcome/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "OperationOutcome",
"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"
/OperationOutcome/{id}/$validate:
get:
tags:
- OperationOutcome
summary: "GET: /OperationOutcome/{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:
- OperationOutcome
summary: "POST: /OperationOutcome/{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": "OperationOutcome",
"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"
/OperationOutcome/{id}/$meta-delete:
post:
tags:
- OperationOutcome
summary: "POST: /OperationOutcome/{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"
/OperationOutcome/{id}/$meta-add:
post:
tags:
- OperationOutcome
summary: "POST: /OperationOutcome/{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"
/OperationOutcome/$meta:
get:
tags:
- OperationOutcome
summary: "GET: /OperationOutcome/$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:
- OperationOutcome
summary: "POST: /OperationOutcome/$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"
/OperationOutcome/{id}/$meta:
get:
tags:
- OperationOutcome
summary: "GET: /OperationOutcome/{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:
- OperationOutcome
summary: "POST: /OperationOutcome/{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"
/OperationOutcome/$expunge:
post:
tags:
- OperationOutcome
summary: "POST: /OperationOutcome/$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"
/OperationOutcome/{id}/$expunge:
post:
tags:
- OperationOutcome
summary: "POST: /OperationOutcome/{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"
/OperationOutcome/{id}/$diff:
get:
tags:
- OperationOutcome
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:
- OperationOutcome
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"
/Organization/{id}:
get:
tags:
- Organization
summary: "read-instance: Read Organization instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Organization
summary: "update-instance: Update an existing Organization instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Organization"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Organization
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Organization
summary: "instance-patch: Patch a resource instance of type Organization by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization/{id}/_history/{version_id}:
get:
tags:
- Organization
summary: "vread-instance: Read Organization instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization:
get:
tags:
- Organization
summary: "search-type: Search for Organization instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Any identifier for the organization (not the accreditation issuer's
identifier)
required: false
schema:
type: string
- name: partof
in: query
description: An organization of which this organization forms a part
required: false
schema:
type: string
- name: address
in: query
description: "A server defined search that may match any of the string fields\
\ in the Address, including line, city, district, state, country, postalCode,\
\ and/or text"
required: false
schema:
type: string
- name: address-state
in: query
description: A state specified in an address
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Is the Organization record active
required: false
schema:
type: string
- name: type
in: query
description: A code for the type of organization
required: false
schema:
type: string
- name: address-postalcode
in: query
description: A postal code specified in an address
required: false
schema:
type: string
- name: address-country
in: query
description: A country specified in an address
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the organization
required: false
schema:
type: string
- name: phonetic
in: query
description: A portion of the organization's name using some kind of phonetic
matching algorithm
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: A use code specified in an address
required: false
schema:
type: string
- name: name
in: query
description: A portion of the organization's name or alias
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: address-city
in: query
description: A city specified in an address
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Organization
summary: "create-type: Create a new Organization instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Organization"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization/_history:
get:
tags:
- Organization
summary: "type-history: Fetch the resource change history for all resources\
\ of type Organization"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization/{id}/_history:
get:
tags:
- Organization
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Organization"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization/_search:
get:
tags:
- Organization
summary: "search-type: Search for Organization instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Any identifier for the organization (not the accreditation issuer's
identifier)
required: false
schema:
type: string
- name: partof
in: query
description: An organization of which this organization forms a part
required: false
schema:
type: string
- name: address
in: query
description: "A server defined search that may match any of the string fields\
\ in the Address, including line, city, district, state, country, postalCode,\
\ and/or text"
required: false
schema:
type: string
- name: address-state
in: query
description: A state specified in an address
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Is the Organization record active
required: false
schema:
type: string
- name: type
in: query
description: A code for the type of organization
required: false
schema:
type: string
- name: address-postalcode
in: query
description: A postal code specified in an address
required: false
schema:
type: string
- name: address-country
in: query
description: A country specified in an address
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the organization
required: false
schema:
type: string
- name: phonetic
in: query
description: A portion of the organization's name using some kind of phonetic
matching algorithm
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: A use code specified in an address
required: false
schema:
type: string
- name: name
in: query
description: A portion of the organization's name or alias
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: address-city
in: query
description: A city specified in an address
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization/$validate:
get:
tags:
- Organization
summary: "GET: /Organization/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Organization
summary: "POST: /Organization/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Organization",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization/{id}/$validate:
get:
tags:
- Organization
summary: "GET: /Organization/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Organization
summary: "POST: /Organization/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Organization",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization/{id}/$meta-delete:
post:
tags:
- Organization
summary: "POST: /Organization/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization/{id}/$meta-add:
post:
tags:
- Organization
summary: "POST: /Organization/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization/$meta:
get:
tags:
- Organization
summary: "GET: /Organization/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Organization
summary: "POST: /Organization/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization/{id}/$meta:
get:
tags:
- Organization
summary: "GET: /Organization/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Organization
summary: "POST: /Organization/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization/$expunge:
post:
tags:
- Organization
summary: "POST: /Organization/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization/{id}/$expunge:
post:
tags:
- Organization
summary: "POST: /Organization/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Organization/{id}/$diff:
get:
tags:
- Organization
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:
- Organization
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"
/OrganizationAffiliation/{id}:
get:
tags:
- OrganizationAffiliation
summary: "read-instance: Read OrganizationAffiliation instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- OrganizationAffiliation
summary: "update-instance: Update an existing OrganizationAffiliation instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "OrganizationAffiliation"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- OrganizationAffiliation
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- OrganizationAffiliation
summary: "instance-patch: Patch a resource instance of type OrganizationAffiliation\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OrganizationAffiliation/{id}/_history/{version_id}:
get:
tags:
- OrganizationAffiliation
summary: "vread-instance: Read OrganizationAffiliation instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OrganizationAffiliation:
get:
tags:
- OrganizationAffiliation
summary: "search-type: Search for OrganizationAffiliation instances"
description: This is a search type
parameters:
- name: date
in: query
description: The period during which the participatingOrganization is affiliated
with the primary organization
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: An organization affiliation's Identifier
required: false
schema:
type: string
- name: specialty
in: query
description: Specific specialty of the participatingOrganization in the context
of the role
required: false
schema:
type: string
- name: role
in: query
description: Definition of the role the participatingOrganization plays
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Whether this organization affiliation record is in active use
required: false
schema:
type: string
- name: primary-organization
in: query
description: The organization that receives the services from the participating
organization
required: false
schema:
type: string
- name: network
in: query
description: Health insurance provider network in which the participatingOrganization
provides the role's services (if defined) at the indicated locations (if
defined)
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: endpoint
in: query
description: Technical endpoints providing access to services operated for
this role
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: phone
in: query
description: A value in a phone contact
required: false
schema:
type: string
- name: service
in: query
description: Healthcare services provided through the role
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: participating-organization
in: query
description: The organization that provides services to the primary organization
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: The location(s) at which the role occurs
required: false
schema:
type: string
- name: telecom
in: query
description: The value in any kind of contact
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: email
in: query
description: A value in an email contact
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- OrganizationAffiliation
summary: "create-type: Create a new OrganizationAffiliation instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "OrganizationAffiliation"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OrganizationAffiliation/_history:
get:
tags:
- OrganizationAffiliation
summary: "type-history: Fetch the resource change history for all resources\
\ of type OrganizationAffiliation"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OrganizationAffiliation/{id}/_history:
get:
tags:
- OrganizationAffiliation
summary: "instance-history: Fetch the resource change history for all resources\
\ of type OrganizationAffiliation"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OrganizationAffiliation/_search:
get:
tags:
- OrganizationAffiliation
summary: "search-type: Search for OrganizationAffiliation instances"
description: This is a search type
parameters:
- name: date
in: query
description: The period during which the participatingOrganization is affiliated
with the primary organization
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: An organization affiliation's Identifier
required: false
schema:
type: string
- name: specialty
in: query
description: Specific specialty of the participatingOrganization in the context
of the role
required: false
schema:
type: string
- name: role
in: query
description: Definition of the role the participatingOrganization plays
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Whether this organization affiliation record is in active use
required: false
schema:
type: string
- name: primary-organization
in: query
description: The organization that receives the services from the participating
organization
required: false
schema:
type: string
- name: network
in: query
description: Health insurance provider network in which the participatingOrganization
provides the role's services (if defined) at the indicated locations (if
defined)
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: endpoint
in: query
description: Technical endpoints providing access to services operated for
this role
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: phone
in: query
description: A value in a phone contact
required: false
schema:
type: string
- name: service
in: query
description: Healthcare services provided through the role
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: participating-organization
in: query
description: The organization that provides services to the primary organization
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: The location(s) at which the role occurs
required: false
schema:
type: string
- name: telecom
in: query
description: The value in any kind of contact
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: email
in: query
description: A value in an email contact
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OrganizationAffiliation/$validate:
get:
tags:
- OrganizationAffiliation
summary: "GET: /OrganizationAffiliation/$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:
- OrganizationAffiliation
summary: "POST: /OrganizationAffiliation/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "OrganizationAffiliation",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/OrganizationAffiliation/{id}/$validate:
get:
tags:
- OrganizationAffiliation
summary: "GET: /OrganizationAffiliation/{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:
- OrganizationAffiliation
summary: "POST: /OrganizationAffiliation/{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": "OrganizationAffiliation",
"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"
/OrganizationAffiliation/{id}/$meta-delete:
post:
tags:
- OrganizationAffiliation
summary: "POST: /OrganizationAffiliation/{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"
/OrganizationAffiliation/{id}/$meta-add:
post:
tags:
- OrganizationAffiliation
summary: "POST: /OrganizationAffiliation/{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"
/OrganizationAffiliation/$meta:
get:
tags:
- OrganizationAffiliation
summary: "GET: /OrganizationAffiliation/$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:
- OrganizationAffiliation
summary: "POST: /OrganizationAffiliation/$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"
/OrganizationAffiliation/{id}/$meta:
get:
tags:
- OrganizationAffiliation
summary: "GET: /OrganizationAffiliation/{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:
- OrganizationAffiliation
summary: "POST: /OrganizationAffiliation/{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"
/OrganizationAffiliation/$expunge:
post:
tags:
- OrganizationAffiliation
summary: "POST: /OrganizationAffiliation/$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"
/OrganizationAffiliation/{id}/$expunge:
post:
tags:
- OrganizationAffiliation
summary: "POST: /OrganizationAffiliation/{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"
/OrganizationAffiliation/{id}/$diff:
get:
tags:
- OrganizationAffiliation
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:
- OrganizationAffiliation
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"
/Parameters/{id}:
get:
tags:
- Parameters
summary: "read-instance: Read Parameters instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Parameters
summary: "update-instance: Update an existing Parameters instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Parameters
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Parameters
summary: "instance-patch: Patch a resource instance of type Parameters by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Parameters/{id}/_history/{version_id}:
get:
tags:
- Parameters
summary: "vread-instance: Read Parameters instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Parameters:
get:
tags:
- Parameters
summary: "search-type: Search for Parameters instances"
description: This is a search type
parameters:
- name: _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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- Parameters
summary: "create-type: Create a new Parameters instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Parameters/_history:
get:
tags:
- Parameters
summary: "type-history: Fetch the resource change history for all resources\
\ of type Parameters"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Parameters/{id}/_history:
get:
tags:
- Parameters
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Parameters"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Parameters/_search:
get:
tags:
- Parameters
summary: "search-type: Search for Parameters instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/Parameters/$validate:
get:
tags:
- Parameters
summary: "GET: /Parameters/$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:
- Parameters
summary: "POST: /Parameters/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Parameters",
"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"
/Parameters/{id}/$validate:
get:
tags:
- Parameters
summary: "GET: /Parameters/{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:
- Parameters
summary: "POST: /Parameters/{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": "Parameters",
"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"
/Parameters/{id}/$meta-delete:
post:
tags:
- Parameters
summary: "POST: /Parameters/{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"
/Parameters/{id}/$meta-add:
post:
tags:
- Parameters
summary: "POST: /Parameters/{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"
/Parameters/$meta:
get:
tags:
- Parameters
summary: "GET: /Parameters/$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:
- Parameters
summary: "POST: /Parameters/$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"
/Parameters/{id}/$meta:
get:
tags:
- Parameters
summary: "GET: /Parameters/{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:
- Parameters
summary: "POST: /Parameters/{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"
/Parameters/$expunge:
post:
tags:
- Parameters
summary: "POST: /Parameters/$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"
/Parameters/{id}/$expunge:
post:
tags:
- Parameters
summary: "POST: /Parameters/{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"
/Parameters/{id}/$diff:
get:
tags:
- Parameters
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:
- Parameters
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Patient/{id}:
get:
tags:
- Patient
summary: "read-instance: Read Patient instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Patient
summary: "update-instance: Update an existing Patient instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Patient"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Patient
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Patient
summary: "instance-patch: Patch a resource instance of type Patient by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Patient/{id}/_history/{version_id}:
get:
tags:
- Patient
summary: "vread-instance: Read Patient instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Patient:
get:
tags:
- Patient
summary: "search-type: Search for Patient instances"
description: This is a search type
parameters:
- name: birthdate
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's\
\ date of birth\r\n* [Person](person.html): The person's date of birth\r\
\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: deceased
in: query
description: "This patient has been marked as deceased, or as a death date\
\ entered"
required: false
schema:
type: string
- name: address-state
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state\
\ specified in an address\r\n* [Person](person.html): A state specified\
\ in an address\r\n* [Practitioner](practitioner.html): A state specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A state specified\
\ in an address"
required: false
schema:
type: string
- name: gender
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender\
\ of the patient\r\n* [Person](person.html): The gender of the person\r\n\
* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html):\
\ Gender of the related person"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: link
in: query
description: All patients linked to the given patient
required: false
schema:
type: string
- name: language
in: query
description: Language code (irrespective of use value)
required: false
schema:
type: string
- name: address-country
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country\
\ specified in an address\r\n* [Person](person.html): A country specified\
\ in an address\r\n* [Practitioner](practitioner.html): A country specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A country specified\
\ in an address"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: death-date
in: query
description: The date of death has been provided and satisfies this search
value
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: phonetic
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of either family or given name using some kind of phonetic matching algorithm\r\
\n* [Person](person.html): A portion of name using some kind of phonetic\
\ matching algorithm\r\n* [Practitioner](practitioner.html): A portion of\
\ either family or given name using some kind of phonetic matching algorithm\r\
\n* [RelatedPerson](relatedperson.html): A portion of name using some kind\
\ of phonetic matching algorithm"
required: false
schema:
type: string
- name: telecom
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\
\ in any kind of telecom details of the patient\r\n* [Person](person.html):\
\ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\
\ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact"
required: false
schema:
type: string
- name: address-city
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city\
\ specified in an address\r\n* [Person](person.html): A city specified in\
\ an address\r\n* [Practitioner](practitioner.html): A city specified in\
\ an address\r\n* [RelatedPerson](relatedperson.html): A city specified\
\ in an address"
required: false
schema:
type: string
- name: email
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in an email contact\r\n* [Person](person.html): A value in an email contact\r\
\n* [Practitioner](practitioner.html): A value in an email contact\r\n*\
\ [PractitionerRole](practitionerrole.html): A value in an email contact\r\
\n* [RelatedPerson](relatedperson.html): A value in an email contact"
required: false
schema:
type: string
- name: given
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of the given name of the patient\r\n* [Practitioner](practitioner.html):\
\ A portion of the given name"
required: false
schema:
type: string
- name: identifier
in: query
description: A patient identifier
required: false
schema:
type: string
- name: address
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server\
\ defined search that may match any of the string fields in the Address,\
\ including line, city, district, state, country, postalCode, and/or text\r\
\n* [Person](person.html): A server defined search that may match any of\
\ the string fields in the Address, including line, city, district, state,\
\ country, postalCode, and/or text\r\n* [Practitioner](practitioner.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text\r\n* [RelatedPerson](relatedperson.html): A server defined search\
\ that may match any of the string fields in the Address, including line,\
\ city, district, state, country, postalCode, and/or text"
required: false
schema:
type: string
- name: general-practitioner
in: query
description: "Patient's nominated general practitioner, not the organization\
\ that manages the record"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Whether the patient record is active
required: false
schema:
type: string
- name: address-postalcode
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode\
\ specified in an address\r\n* [Person](person.html): A postal code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A postalCode specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A postal code\
\ specified in an address"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: phone
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\
\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A\
\ value in a phone contact"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The organization that is the custodian of the patient record
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use\
\ code specified in an address\r\n* [Person](person.html): A use code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A use code specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified\
\ in an address"
required: false
schema:
type: string
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
\ text"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: family
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of the family name of the patient\r\n* [Practitioner](practitioner.html):\
\ A portion of the family name"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Patient
summary: "create-type: Create a new Patient instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Patient"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Patient/_history:
get:
tags:
- Patient
summary: "type-history: Fetch the resource change history for all resources\
\ of type Patient"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Patient/{id}/_history:
get:
tags:
- Patient
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Patient"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Patient/_search:
get:
tags:
- Patient
summary: "search-type: Search for Patient instances"
description: This is a search type
parameters:
- name: birthdate
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's\
\ date of birth\r\n* [Person](person.html): The person's date of birth\r\
\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: deceased
in: query
description: "This patient has been marked as deceased, or as a death date\
\ entered"
required: false
schema:
type: string
- name: address-state
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state\
\ specified in an address\r\n* [Person](person.html): A state specified\
\ in an address\r\n* [Practitioner](practitioner.html): A state specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A state specified\
\ in an address"
required: false
schema:
type: string
- name: gender
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender\
\ of the patient\r\n* [Person](person.html): The gender of the person\r\n\
* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html):\
\ Gender of the related person"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: link
in: query
description: All patients linked to the given patient
required: false
schema:
type: string
- name: language
in: query
description: Language code (irrespective of use value)
required: false
schema:
type: string
- name: address-country
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country\
\ specified in an address\r\n* [Person](person.html): A country specified\
\ in an address\r\n* [Practitioner](practitioner.html): A country specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A country specified\
\ in an address"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: death-date
in: query
description: The date of death has been provided and satisfies this search
value
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: phonetic
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of either family or given name using some kind of phonetic matching algorithm\r\
\n* [Person](person.html): A portion of name using some kind of phonetic\
\ matching algorithm\r\n* [Practitioner](practitioner.html): A portion of\
\ either family or given name using some kind of phonetic matching algorithm\r\
\n* [RelatedPerson](relatedperson.html): A portion of name using some kind\
\ of phonetic matching algorithm"
required: false
schema:
type: string
- name: telecom
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\
\ in any kind of telecom details of the patient\r\n* [Person](person.html):\
\ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\
\ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact"
required: false
schema:
type: string
- name: address-city
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city\
\ specified in an address\r\n* [Person](person.html): A city specified in\
\ an address\r\n* [Practitioner](practitioner.html): A city specified in\
\ an address\r\n* [RelatedPerson](relatedperson.html): A city specified\
\ in an address"
required: false
schema:
type: string
- name: email
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in an email contact\r\n* [Person](person.html): A value in an email contact\r\
\n* [Practitioner](practitioner.html): A value in an email contact\r\n*\
\ [PractitionerRole](practitionerrole.html): A value in an email contact\r\
\n* [RelatedPerson](relatedperson.html): A value in an email contact"
required: false
schema:
type: string
- name: given
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of the given name of the patient\r\n* [Practitioner](practitioner.html):\
\ A portion of the given name"
required: false
schema:
type: string
- name: identifier
in: query
description: A patient identifier
required: false
schema:
type: string
- name: address
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server\
\ defined search that may match any of the string fields in the Address,\
\ including line, city, district, state, country, postalCode, and/or text\r\
\n* [Person](person.html): A server defined search that may match any of\
\ the string fields in the Address, including line, city, district, state,\
\ country, postalCode, and/or text\r\n* [Practitioner](practitioner.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text\r\n* [RelatedPerson](relatedperson.html): A server defined search\
\ that may match any of the string fields in the Address, including line,\
\ city, district, state, country, postalCode, and/or text"
required: false
schema:
type: string
- name: general-practitioner
in: query
description: "Patient's nominated general practitioner, not the organization\
\ that manages the record"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Whether the patient record is active
required: false
schema:
type: string
- name: address-postalcode
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode\
\ specified in an address\r\n* [Person](person.html): A postal code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A postalCode specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A postal code\
\ specified in an address"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: phone
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\
\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A\
\ value in a phone contact"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The organization that is the custodian of the patient record
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use\
\ code specified in an address\r\n* [Person](person.html): A use code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A use code specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified\
\ in an address"
required: false
schema:
type: string
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
\ text"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: family
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of the family name of the patient\r\n* [Practitioner](practitioner.html):\
\ A portion of the family name"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Patient/$validate:
get:
tags:
- Patient
summary: "GET: /Patient/$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:
- Patient
summary: "POST: /Patient/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Patient",
"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"
/Patient/{id}/$validate:
get:
tags:
- Patient
summary: "GET: /Patient/{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:
- Patient
summary: "POST: /Patient/{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": "Patient",
"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"
/Patient/{id}/$meta-delete:
post:
tags:
- Patient
summary: "POST: /Patient/{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"
/Patient/{id}/$meta-add:
post:
tags:
- Patient
summary: "POST: /Patient/{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"
/Patient/$meta:
get:
tags:
- Patient
summary: "GET: /Patient/$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:
- Patient
summary: "POST: /Patient/$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"
/Patient/{id}/$meta:
get:
tags:
- Patient
summary: "GET: /Patient/{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:
- Patient
summary: "POST: /Patient/{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"
/Patient/$expunge:
post:
tags:
- Patient
summary: "POST: /Patient/$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"
/Patient/{id}/$expunge:
post:
tags:
- Patient
summary: "POST: /Patient/{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"
/Patient/$everything:
get:
tags:
- Patient
summary: "GET: /Patient/$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 (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: _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: "Filter the resources to return only resources matching the given\
\ _type filter (note that this filter is applied only to results which link\
\ to the given patient, not to the patient itself or to supporting resources\
\ linked to by the matched resources)"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Patient
summary: "POST: /Patient/$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"
/Patient/{id}/$everything:
get:
tags:
- Patient
summary: "GET: /Patient/{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 (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: _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: "Filter the resources to return only resources matching the given\
\ _type filter (note that this filter is applied only to results which link\
\ to the given patient, not to the patient itself or to supporting resources\
\ linked to by the matched resources)"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Patient
summary: "POST: /Patient/{id}/$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"
/Patient/{id}/$diff:
get:
tags:
- Patient
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Patient
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PaymentNotice/{id}:
get:
tags:
- PaymentNotice
summary: "read-instance: Read PaymentNotice instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- PaymentNotice
summary: "update-instance: Update an existing PaymentNotice instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "PaymentNotice"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- PaymentNotice
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- PaymentNotice
summary: "instance-patch: Patch a resource instance of type PaymentNotice by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PaymentNotice/{id}/_history/{version_id}:
get:
tags:
- PaymentNotice
summary: "vread-instance: Read PaymentNotice instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PaymentNotice:
get:
tags:
- PaymentNotice
summary: "search-type: Search for PaymentNotice instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier of the notice
required: false
schema:
type: string
- name: request
in: query
description: The Claim
required: false
schema:
type: string
- name: created
in: query
description: Creation date fro the notice
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: payment-status
in: query
description: The type of payment notice
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: provider
in: query
description: The reference to the provider
required: false
schema:
type: string
- name: response
in: query
description: The ClaimResponse
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 payment notice
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:
- PaymentNotice
summary: "create-type: Create a new PaymentNotice instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "PaymentNotice"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PaymentNotice/_history:
get:
tags:
- PaymentNotice
summary: "type-history: Fetch the resource change history for all resources\
\ of type PaymentNotice"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PaymentNotice/{id}/_history:
get:
tags:
- PaymentNotice
summary: "instance-history: Fetch the resource change history for all resources\
\ of type PaymentNotice"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PaymentNotice/_search:
get:
tags:
- PaymentNotice
summary: "search-type: Search for PaymentNotice instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier of the notice
required: false
schema:
type: string
- name: request
in: query
description: The Claim
required: false
schema:
type: string
- name: created
in: query
description: Creation date fro the notice
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: payment-status
in: query
description: The type of payment notice
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: provider
in: query
description: The reference to the provider
required: false
schema:
type: string
- name: response
in: query
description: The ClaimResponse
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 payment notice
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"
/PaymentNotice/$validate:
get:
tags:
- PaymentNotice
summary: "GET: /PaymentNotice/$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:
- PaymentNotice
summary: "POST: /PaymentNotice/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "PaymentNotice",
"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"
/PaymentNotice/{id}/$validate:
get:
tags:
- PaymentNotice
summary: "GET: /PaymentNotice/{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:
- PaymentNotice
summary: "POST: /PaymentNotice/{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": "PaymentNotice",
"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"
/PaymentNotice/{id}/$meta-delete:
post:
tags:
- PaymentNotice
summary: "POST: /PaymentNotice/{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"
/PaymentNotice/{id}/$meta-add:
post:
tags:
- PaymentNotice
summary: "POST: /PaymentNotice/{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"
/PaymentNotice/$meta:
get:
tags:
- PaymentNotice
summary: "GET: /PaymentNotice/$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:
- PaymentNotice
summary: "POST: /PaymentNotice/$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"
/PaymentNotice/{id}/$meta:
get:
tags:
- PaymentNotice
summary: "GET: /PaymentNotice/{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:
- PaymentNotice
summary: "POST: /PaymentNotice/{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"
/PaymentNotice/$expunge:
post:
tags:
- PaymentNotice
summary: "POST: /PaymentNotice/$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"
/PaymentNotice/{id}/$expunge:
post:
tags:
- PaymentNotice
summary: "POST: /PaymentNotice/{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"
/PaymentNotice/{id}/$diff:
get:
tags:
- PaymentNotice
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:
- PaymentNotice
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"
/PaymentReconciliation/{id}:
get:
tags:
- PaymentReconciliation
summary: "read-instance: Read PaymentReconciliation instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- PaymentReconciliation
summary: "update-instance: Update an existing PaymentReconciliation instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "PaymentReconciliation"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- PaymentReconciliation
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- PaymentReconciliation
summary: "instance-patch: Patch a resource instance of type PaymentReconciliation\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PaymentReconciliation/{id}/_history/{version_id}:
get:
tags:
- PaymentReconciliation
summary: "vread-instance: Read PaymentReconciliation instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PaymentReconciliation:
get:
tags:
- PaymentReconciliation
summary: "search-type: Search for PaymentReconciliation instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier of the ExplanationOfBenefit
required: false
schema:
type: string
- name: request
in: query
description: The reference to the claim
required: false
schema:
type: string
- name: created
in: query
description: The creation date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: requestor
in: query
description: The reference to the provider who submitted the claim
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: disposition
in: query
description: The contents of the disposition message
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: outcome
in: query
description: The processing outcome
required: false
schema:
type: string
- name: payment-issuer
in: query
description: The organization which generated this resource
required: false
schema:
type: string
- name: status
in: query
description: The status of the payment reconciliation
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:
- PaymentReconciliation
summary: "create-type: Create a new PaymentReconciliation instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "PaymentReconciliation"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PaymentReconciliation/_history:
get:
tags:
- PaymentReconciliation
summary: "type-history: Fetch the resource change history for all resources\
\ of type PaymentReconciliation"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PaymentReconciliation/{id}/_history:
get:
tags:
- PaymentReconciliation
summary: "instance-history: Fetch the resource change history for all resources\
\ of type PaymentReconciliation"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PaymentReconciliation/_search:
get:
tags:
- PaymentReconciliation
summary: "search-type: Search for PaymentReconciliation instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: The business identifier of the ExplanationOfBenefit
required: false
schema:
type: string
- name: request
in: query
description: The reference to the claim
required: false
schema:
type: string
- name: created
in: query
description: The creation date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: requestor
in: query
description: The reference to the provider who submitted the claim
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: disposition
in: query
description: The contents of the disposition message
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: outcome
in: query
description: The processing outcome
required: false
schema:
type: string
- name: payment-issuer
in: query
description: The organization which generated this resource
required: false
schema:
type: string
- name: status
in: query
description: The status of the payment reconciliation
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"
/PaymentReconciliation/$validate:
get:
tags:
- PaymentReconciliation
summary: "GET: /PaymentReconciliation/$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:
- PaymentReconciliation
summary: "POST: /PaymentReconciliation/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "PaymentReconciliation",
"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"
/PaymentReconciliation/{id}/$validate:
get:
tags:
- PaymentReconciliation
summary: "GET: /PaymentReconciliation/{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:
- PaymentReconciliation
summary: "POST: /PaymentReconciliation/{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": "PaymentReconciliation",
"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"
/PaymentReconciliation/{id}/$meta-delete:
post:
tags:
- PaymentReconciliation
summary: "POST: /PaymentReconciliation/{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"
/PaymentReconciliation/{id}/$meta-add:
post:
tags:
- PaymentReconciliation
summary: "POST: /PaymentReconciliation/{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"
/PaymentReconciliation/$meta:
get:
tags:
- PaymentReconciliation
summary: "GET: /PaymentReconciliation/$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:
- PaymentReconciliation
summary: "POST: /PaymentReconciliation/$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"
/PaymentReconciliation/{id}/$meta:
get:
tags:
- PaymentReconciliation
summary: "GET: /PaymentReconciliation/{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:
- PaymentReconciliation
summary: "POST: /PaymentReconciliation/{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"
/PaymentReconciliation/$expunge:
post:
tags:
- PaymentReconciliation
summary: "POST: /PaymentReconciliation/$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"
/PaymentReconciliation/{id}/$expunge:
post:
tags:
- PaymentReconciliation
summary: "POST: /PaymentReconciliation/{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"
/PaymentReconciliation/{id}/$diff:
get:
tags:
- PaymentReconciliation
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:
- PaymentReconciliation
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"
/Person/{id}:
get:
tags:
- Person
summary: "read-instance: Read Person instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Person
summary: "update-instance: Update an existing Person instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Person"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Person
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Person
summary: "instance-patch: Patch a resource instance of type Person by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Person/{id}/_history/{version_id}:
get:
tags:
- Person
summary: "vread-instance: Read Person instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Person:
get:
tags:
- Person
summary: "search-type: Search for Person instances"
description: This is a search type
parameters:
- name: birthdate
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's\
\ date of birth\r\n* [Person](person.html): The person's date of birth\r\
\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: address-state
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state\
\ specified in an address\r\n* [Person](person.html): A state specified\
\ in an address\r\n* [Practitioner](practitioner.html): A state specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A state specified\
\ in an address"
required: false
schema:
type: string
- name: gender
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender\
\ of the patient\r\n* [Person](person.html): The gender of the person\r\n\
* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html):\
\ Gender of the related person"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: link
in: query
description: "Any link has this Patient, Person, RelatedPerson or Practitioner\
\ reference"
required: false
schema:
type: string
- name: address-country
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country\
\ specified in an address\r\n* [Person](person.html): A country specified\
\ in an address\r\n* [Practitioner](practitioner.html): A country specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A country specified\
\ in an address"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: phonetic
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of either family or given name using some kind of phonetic matching algorithm\r\
\n* [Person](person.html): A portion of name using some kind of phonetic\
\ matching algorithm\r\n* [Practitioner](practitioner.html): A portion of\
\ either family or given name using some kind of phonetic matching algorithm\r\
\n* [RelatedPerson](relatedperson.html): A portion of name using some kind\
\ of phonetic matching algorithm"
required: false
schema:
type: string
- name: patient
in: query
description: The Person links to this Patient
required: false
schema:
type: string
- name: telecom
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\
\ in any kind of telecom details of the patient\r\n* [Person](person.html):\
\ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\
\ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact"
required: false
schema:
type: string
- name: address-city
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city\
\ specified in an address\r\n* [Person](person.html): A city specified in\
\ an address\r\n* [Practitioner](practitioner.html): A city specified in\
\ an address\r\n* [RelatedPerson](relatedperson.html): A city specified\
\ in an address"
required: false
schema:
type: string
- name: email
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in an email contact\r\n* [Person](person.html): A value in an email contact\r\
\n* [Practitioner](practitioner.html): A value in an email contact\r\n*\
\ [PractitionerRole](practitionerrole.html): A value in an email contact\r\
\n* [RelatedPerson](relatedperson.html): A value in an email contact"
required: false
schema:
type: string
- name: identifier
in: query
description: A person Identifier
required: false
schema:
type: string
- name: address
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server\
\ defined search that may match any of the string fields in the Address,\
\ including line, city, district, state, country, postalCode, and/or text\r\
\n* [Person](person.html): A server defined search that may match any of\
\ the string fields in the Address, including line, city, district, state,\
\ country, postalCode, and/or text\r\n* [Practitioner](practitioner.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text\r\n* [RelatedPerson](relatedperson.html): A server defined search\
\ that may match any of the string fields in the Address, including line,\
\ city, district, state, country, postalCode, and/or text"
required: false
schema:
type: string
- name: practitioner
in: query
description: The Person links to this Practitioner
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: relatedperson
in: query
description: The Person links to this RelatedPerson
required: false
schema:
type: string
- name: address-postalcode
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode\
\ specified in an address\r\n* [Person](person.html): A postal code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A postalCode specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A postal code\
\ specified in an address"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: phone
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\
\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A\
\ value in a phone contact"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The organization at which this person record is being managed
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use\
\ code specified in an address\r\n* [Person](person.html): A use code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A use code specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified\
\ in an address"
required: false
schema:
type: string
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
\ text"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Person
summary: "create-type: Create a new Person instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Person"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Person/_history:
get:
tags:
- Person
summary: "type-history: Fetch the resource change history for all resources\
\ of type Person"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Person/{id}/_history:
get:
tags:
- Person
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Person"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Person/_search:
get:
tags:
- Person
summary: "search-type: Search for Person instances"
description: This is a search type
parameters:
- name: birthdate
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's\
\ date of birth\r\n* [Person](person.html): The person's date of birth\r\
\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: address-state
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state\
\ specified in an address\r\n* [Person](person.html): A state specified\
\ in an address\r\n* [Practitioner](practitioner.html): A state specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A state specified\
\ in an address"
required: false
schema:
type: string
- name: gender
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender\
\ of the patient\r\n* [Person](person.html): The gender of the person\r\n\
* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html):\
\ Gender of the related person"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: link
in: query
description: "Any link has this Patient, Person, RelatedPerson or Practitioner\
\ reference"
required: false
schema:
type: string
- name: address-country
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country\
\ specified in an address\r\n* [Person](person.html): A country specified\
\ in an address\r\n* [Practitioner](practitioner.html): A country specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A country specified\
\ in an address"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: phonetic
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of either family or given name using some kind of phonetic matching algorithm\r\
\n* [Person](person.html): A portion of name using some kind of phonetic\
\ matching algorithm\r\n* [Practitioner](practitioner.html): A portion of\
\ either family or given name using some kind of phonetic matching algorithm\r\
\n* [RelatedPerson](relatedperson.html): A portion of name using some kind\
\ of phonetic matching algorithm"
required: false
schema:
type: string
- name: patient
in: query
description: The Person links to this Patient
required: false
schema:
type: string
- name: telecom
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\
\ in any kind of telecom details of the patient\r\n* [Person](person.html):\
\ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\
\ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact"
required: false
schema:
type: string
- name: address-city
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city\
\ specified in an address\r\n* [Person](person.html): A city specified in\
\ an address\r\n* [Practitioner](practitioner.html): A city specified in\
\ an address\r\n* [RelatedPerson](relatedperson.html): A city specified\
\ in an address"
required: false
schema:
type: string
- name: email
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in an email contact\r\n* [Person](person.html): A value in an email contact\r\
\n* [Practitioner](practitioner.html): A value in an email contact\r\n*\
\ [PractitionerRole](practitionerrole.html): A value in an email contact\r\
\n* [RelatedPerson](relatedperson.html): A value in an email contact"
required: false
schema:
type: string
- name: identifier
in: query
description: A person Identifier
required: false
schema:
type: string
- name: address
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server\
\ defined search that may match any of the string fields in the Address,\
\ including line, city, district, state, country, postalCode, and/or text\r\
\n* [Person](person.html): A server defined search that may match any of\
\ the string fields in the Address, including line, city, district, state,\
\ country, postalCode, and/or text\r\n* [Practitioner](practitioner.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text\r\n* [RelatedPerson](relatedperson.html): A server defined search\
\ that may match any of the string fields in the Address, including line,\
\ city, district, state, country, postalCode, and/or text"
required: false
schema:
type: string
- name: practitioner
in: query
description: The Person links to this Practitioner
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: relatedperson
in: query
description: The Person links to this RelatedPerson
required: false
schema:
type: string
- name: address-postalcode
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode\
\ specified in an address\r\n* [Person](person.html): A postal code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A postalCode specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A postal code\
\ specified in an address"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: phone
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\
\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A\
\ value in a phone contact"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The organization at which this person record is being managed
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use\
\ code specified in an address\r\n* [Person](person.html): A use code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A use code specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified\
\ in an address"
required: false
schema:
type: string
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
\ text"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Person/$validate:
get:
tags:
- Person
summary: "GET: /Person/$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:
- Person
summary: "POST: /Person/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Person",
"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"
/Person/{id}/$validate:
get:
tags:
- Person
summary: "GET: /Person/{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:
- Person
summary: "POST: /Person/{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": "Person",
"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"
/Person/{id}/$meta-delete:
post:
tags:
- Person
summary: "POST: /Person/{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"
/Person/{id}/$meta-add:
post:
tags:
- Person
summary: "POST: /Person/{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"
/Person/$meta:
get:
tags:
- Person
summary: "GET: /Person/$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:
- Person
summary: "POST: /Person/$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"
/Person/{id}/$meta:
get:
tags:
- Person
summary: "GET: /Person/{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:
- Person
summary: "POST: /Person/{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"
/Person/$expunge:
post:
tags:
- Person
summary: "POST: /Person/$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"
/Person/{id}/$expunge:
post:
tags:
- Person
summary: "POST: /Person/{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"
/Person/{id}/$diff:
get:
tags:
- Person
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:
- Person
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"
/PlanDefinition/{id}:
get:
tags:
- PlanDefinition
summary: "read-instance: Read PlanDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- PlanDefinition
summary: "update-instance: Update an existing PlanDefinition instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "PlanDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- PlanDefinition
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- PlanDefinition
summary: "instance-patch: Patch a resource instance of type PlanDefinition by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PlanDefinition/{id}/_history/{version_id}:
get:
tags:
- PlanDefinition
summary: "vread-instance: Read PlanDefinition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PlanDefinition:
get:
tags:
- PlanDefinition
summary: "search-type: Search for PlanDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The plan definition publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the plan definition
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the plan definition
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the plan definition
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the plan definition
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the plan definition
required: false
schema:
type: string
- name: type
in: query
description: "The type of artifact the plan (e.g. order-set, eca-rule, protocol)"
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: A quantity- or range-valued use context assigned to the plan
definition
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the plan definition is intended to be in
use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the plan definition
required: false
schema:
type: string
- name: definition
in: query
description: Activity or plan definitions used by plan definition
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the plan definition
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the plan definition
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: The business version of the plan definition
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the plan definition
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: Computationally friendly name of the plan definition
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the plan definition
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the module
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 plan definition
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:
- PlanDefinition
summary: "create-type: Create a new PlanDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "PlanDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PlanDefinition/_history:
get:
tags:
- PlanDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type PlanDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PlanDefinition/{id}/_history:
get:
tags:
- PlanDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type PlanDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PlanDefinition/_search:
get:
tags:
- PlanDefinition
summary: "search-type: Search for PlanDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The plan definition publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the plan definition
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the plan definition
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the plan definition
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the plan definition
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the plan definition
required: false
schema:
type: string
- name: type
in: query
description: "The type of artifact the plan (e.g. order-set, eca-rule, protocol)"
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: A quantity- or range-valued use context assigned to the plan
definition
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the plan definition is intended to be in
use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the plan definition
required: false
schema:
type: string
- name: definition
in: query
description: Activity or plan definitions used by plan definition
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the plan definition
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the plan definition
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: The business version of the plan definition
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the plan definition
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: Computationally friendly name of the plan definition
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the plan definition
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the module
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 plan definition
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"
/PlanDefinition/$validate:
get:
tags:
- PlanDefinition
summary: "GET: /PlanDefinition/$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:
- PlanDefinition
summary: "POST: /PlanDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "PlanDefinition",
"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"
/PlanDefinition/{id}/$validate:
get:
tags:
- PlanDefinition
summary: "GET: /PlanDefinition/{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:
- PlanDefinition
summary: "POST: /PlanDefinition/{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": "PlanDefinition",
"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"
/PlanDefinition/{id}/$meta-delete:
post:
tags:
- PlanDefinition
summary: "POST: /PlanDefinition/{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"
/PlanDefinition/{id}/$meta-add:
post:
tags:
- PlanDefinition
summary: "POST: /PlanDefinition/{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"
/PlanDefinition/$meta:
get:
tags:
- PlanDefinition
summary: "GET: /PlanDefinition/$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:
- PlanDefinition
summary: "POST: /PlanDefinition/$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"
/PlanDefinition/{id}/$meta:
get:
tags:
- PlanDefinition
summary: "GET: /PlanDefinition/{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:
- PlanDefinition
summary: "POST: /PlanDefinition/{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"
/PlanDefinition/$expunge:
post:
tags:
- PlanDefinition
summary: "POST: /PlanDefinition/$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"
/PlanDefinition/{id}/$expunge:
post:
tags:
- PlanDefinition
summary: "POST: /PlanDefinition/{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"
/PlanDefinition/{id}/$diff:
get:
tags:
- PlanDefinition
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:
- PlanDefinition
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"
/Practitioner/{id}:
get:
tags:
- Practitioner
summary: "read-instance: Read Practitioner instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Practitioner
summary: "update-instance: Update an existing Practitioner instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Practitioner"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Practitioner
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Practitioner
summary: "instance-patch: Patch a resource instance of type Practitioner by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner/{id}/_history/{version_id}:
get:
tags:
- Practitioner
summary: "vread-instance: Read Practitioner instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner:
get:
tags:
- Practitioner
summary: "search-type: Search for Practitioner instances"
description: This is a search type
parameters:
- name: address-state
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state\
\ specified in an address\r\n* [Person](person.html): A state specified\
\ in an address\r\n* [Practitioner](practitioner.html): A state specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A state specified\
\ in an address"
required: false
schema:
type: string
- name: gender
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender\
\ of the patient\r\n* [Person](person.html): The gender of the person\r\n\
* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html):\
\ Gender of the related person"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: address-country
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country\
\ specified in an address\r\n* [Person](person.html): A country specified\
\ in an address\r\n* [Practitioner](practitioner.html): A country specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A country specified\
\ in an address"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: phonetic
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of either family or given name using some kind of phonetic matching algorithm\r\
\n* [Person](person.html): A portion of name using some kind of phonetic\
\ matching algorithm\r\n* [Practitioner](practitioner.html): A portion of\
\ either family or given name using some kind of phonetic matching algorithm\r\
\n* [RelatedPerson](relatedperson.html): A portion of name using some kind\
\ of phonetic matching algorithm"
required: false
schema:
type: string
- name: telecom
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\
\ in any kind of telecom details of the patient\r\n* [Person](person.html):\
\ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\
\ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact"
required: false
schema:
type: string
- name: address-city
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city\
\ specified in an address\r\n* [Person](person.html): A city specified in\
\ an address\r\n* [Practitioner](practitioner.html): A city specified in\
\ an address\r\n* [RelatedPerson](relatedperson.html): A city specified\
\ in an address"
required: false
schema:
type: string
- name: communication
in: query
description: One of the languages that the practitioner can communicate with
required: false
schema:
type: string
- name: email
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in an email contact\r\n* [Person](person.html): A value in an email contact\r\
\n* [Practitioner](practitioner.html): A value in an email contact\r\n*\
\ [PractitionerRole](practitionerrole.html): A value in an email contact\r\
\n* [RelatedPerson](relatedperson.html): A value in an email contact"
required: false
schema:
type: string
- name: given
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of the given name of the patient\r\n* [Practitioner](practitioner.html):\
\ A portion of the given name"
required: false
schema:
type: string
- name: identifier
in: query
description: A practitioner's Identifier
required: false
schema:
type: string
- name: address
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server\
\ defined search that may match any of the string fields in the Address,\
\ including line, city, district, state, country, postalCode, and/or text\r\
\n* [Person](person.html): A server defined search that may match any of\
\ the string fields in the Address, including line, city, district, state,\
\ country, postalCode, and/or text\r\n* [Practitioner](practitioner.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text\r\n* [RelatedPerson](relatedperson.html): A server defined search\
\ that may match any of the string fields in the Address, including line,\
\ city, district, state, country, postalCode, and/or text"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Whether the practitioner record is active
required: false
schema:
type: string
- name: address-postalcode
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode\
\ specified in an address\r\n* [Person](person.html): A postal code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A postalCode specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A postal code\
\ specified in an address"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: phone
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\
\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A\
\ value in a phone contact"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use\
\ code specified in an address\r\n* [Person](person.html): A use code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A use code specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified\
\ in an address"
required: false
schema:
type: string
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
\ text"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: family
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of the family name of the patient\r\n* [Practitioner](practitioner.html):\
\ A portion of the family name"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Practitioner
summary: "create-type: Create a new Practitioner instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Practitioner"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner/_history:
get:
tags:
- Practitioner
summary: "type-history: Fetch the resource change history for all resources\
\ of type Practitioner"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner/{id}/_history:
get:
tags:
- Practitioner
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Practitioner"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner/_search:
get:
tags:
- Practitioner
summary: "search-type: Search for Practitioner instances"
description: This is a search type
parameters:
- name: address-state
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state\
\ specified in an address\r\n* [Person](person.html): A state specified\
\ in an address\r\n* [Practitioner](practitioner.html): A state specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A state specified\
\ in an address"
required: false
schema:
type: string
- name: gender
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender\
\ of the patient\r\n* [Person](person.html): The gender of the person\r\n\
* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html):\
\ Gender of the related person"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: address-country
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country\
\ specified in an address\r\n* [Person](person.html): A country specified\
\ in an address\r\n* [Practitioner](practitioner.html): A country specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A country specified\
\ in an address"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: phonetic
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of either family or given name using some kind of phonetic matching algorithm\r\
\n* [Person](person.html): A portion of name using some kind of phonetic\
\ matching algorithm\r\n* [Practitioner](practitioner.html): A portion of\
\ either family or given name using some kind of phonetic matching algorithm\r\
\n* [RelatedPerson](relatedperson.html): A portion of name using some kind\
\ of phonetic matching algorithm"
required: false
schema:
type: string
- name: telecom
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\
\ in any kind of telecom details of the patient\r\n* [Person](person.html):\
\ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\
\ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact"
required: false
schema:
type: string
- name: address-city
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city\
\ specified in an address\r\n* [Person](person.html): A city specified in\
\ an address\r\n* [Practitioner](practitioner.html): A city specified in\
\ an address\r\n* [RelatedPerson](relatedperson.html): A city specified\
\ in an address"
required: false
schema:
type: string
- name: communication
in: query
description: One of the languages that the practitioner can communicate with
required: false
schema:
type: string
- name: email
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in an email contact\r\n* [Person](person.html): A value in an email contact\r\
\n* [Practitioner](practitioner.html): A value in an email contact\r\n*\
\ [PractitionerRole](practitionerrole.html): A value in an email contact\r\
\n* [RelatedPerson](relatedperson.html): A value in an email contact"
required: false
schema:
type: string
- name: given
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of the given name of the patient\r\n* [Practitioner](practitioner.html):\
\ A portion of the given name"
required: false
schema:
type: string
- name: identifier
in: query
description: A practitioner's Identifier
required: false
schema:
type: string
- name: address
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server\
\ defined search that may match any of the string fields in the Address,\
\ including line, city, district, state, country, postalCode, and/or text\r\
\n* [Person](person.html): A server defined search that may match any of\
\ the string fields in the Address, including line, city, district, state,\
\ country, postalCode, and/or text\r\n* [Practitioner](practitioner.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text\r\n* [RelatedPerson](relatedperson.html): A server defined search\
\ that may match any of the string fields in the Address, including line,\
\ city, district, state, country, postalCode, and/or text"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Whether the practitioner record is active
required: false
schema:
type: string
- name: address-postalcode
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode\
\ specified in an address\r\n* [Person](person.html): A postal code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A postalCode specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A postal code\
\ specified in an address"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: phone
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\
\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A\
\ value in a phone contact"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use\
\ code specified in an address\r\n* [Person](person.html): A use code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A use code specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified\
\ in an address"
required: false
schema:
type: string
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
\ text"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: family
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of the family name of the patient\r\n* [Practitioner](practitioner.html):\
\ A portion of the family name"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner/$validate:
get:
tags:
- Practitioner
summary: "GET: /Practitioner/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Practitioner
summary: "POST: /Practitioner/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Practitioner",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner/{id}/$validate:
get:
tags:
- Practitioner
summary: "GET: /Practitioner/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Practitioner
summary: "POST: /Practitioner/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Practitioner",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner/{id}/$meta-delete:
post:
tags:
- Practitioner
summary: "POST: /Practitioner/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner/{id}/$meta-add:
post:
tags:
- Practitioner
summary: "POST: /Practitioner/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner/$meta:
get:
tags:
- Practitioner
summary: "GET: /Practitioner/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Practitioner
summary: "POST: /Practitioner/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner/{id}/$meta:
get:
tags:
- Practitioner
summary: "GET: /Practitioner/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Practitioner
summary: "POST: /Practitioner/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner/$expunge:
post:
tags:
- Practitioner
summary: "POST: /Practitioner/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner/{id}/$expunge:
post:
tags:
- Practitioner
summary: "POST: /Practitioner/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Practitioner/{id}/$diff:
get:
tags:
- Practitioner
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:
- Practitioner
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"
/PractitionerRole/{id}:
get:
tags:
- PractitionerRole
summary: "read-instance: Read PractitionerRole instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- PractitionerRole
summary: "update-instance: Update an existing PractitionerRole instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "PractitionerRole"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- PractitionerRole
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- PractitionerRole
summary: "instance-patch: Patch a resource instance of type PractitionerRole\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole/{id}/_history/{version_id}:
get:
tags:
- PractitionerRole
summary: "vread-instance: Read PractitionerRole instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole:
get:
tags:
- PractitionerRole
summary: "search-type: Search for PractitionerRole instances"
description: This is a search type
parameters:
- name: date
in: query
description: The period during which the practitioner is authorized to perform
in these role(s)
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: A practitioner's Identifier
required: false
schema:
type: string
- name: specialty
in: query
description: The practitioner has this specialty at an organization
required: false
schema:
type: string
- name: role
in: query
description: The practitioner can perform this role at for the organization
required: false
schema:
type: string
- name: practitioner
in: query
description: Practitioner that is able to provide the defined services for
the organization
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Whether this practitioner role record is in active use
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the practitioner with this role
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: phone
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\
\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A\
\ value in a phone contact"
required: false
schema:
type: string
- name: service
in: query
description: The list of healthcare services that this worker provides for
this role's Organization/Location(s)
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The identity of the organization the practitioner represents
/ acts on behalf of
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: telecom
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\
\ in any kind of telecom details of the patient\r\n* [Person](person.html):\
\ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\
\ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact"
required: false
schema:
type: string
- name: location
in: query
description: One of the locations at which this practitioner provides care
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: email
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in an email contact\r\n* [Person](person.html): A value in an email contact\r\
\n* [Practitioner](practitioner.html): A value in an email contact\r\n*\
\ [PractitionerRole](practitionerrole.html): A value in an email contact\r\
\n* [RelatedPerson](relatedperson.html): A value in an email contact"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- PractitionerRole
summary: "create-type: Create a new PractitionerRole instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "PractitionerRole"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole/_history:
get:
tags:
- PractitionerRole
summary: "type-history: Fetch the resource change history for all resources\
\ of type PractitionerRole"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole/{id}/_history:
get:
tags:
- PractitionerRole
summary: "instance-history: Fetch the resource change history for all resources\
\ of type PractitionerRole"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole/_search:
get:
tags:
- PractitionerRole
summary: "search-type: Search for PractitionerRole instances"
description: This is a search type
parameters:
- name: date
in: query
description: The period during which the practitioner is authorized to perform
in these role(s)
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: A practitioner's Identifier
required: false
schema:
type: string
- name: specialty
in: query
description: The practitioner has this specialty at an organization
required: false
schema:
type: string
- name: role
in: query
description: The practitioner can perform this role at for the organization
required: false
schema:
type: string
- name: practitioner
in: query
description: Practitioner that is able to provide the defined services for
the organization
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Whether this practitioner role record is in active use
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for
the practitioner with this role
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: phone
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\
\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A\
\ value in a phone contact"
required: false
schema:
type: string
- name: service
in: query
description: The list of healthcare services that this worker provides for
this role's Organization/Location(s)
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: organization
in: query
description: The identity of the organization the practitioner represents
/ acts on behalf of
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: telecom
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\
\ in any kind of telecom details of the patient\r\n* [Person](person.html):\
\ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\
\ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact"
required: false
schema:
type: string
- name: location
in: query
description: One of the locations at which this practitioner provides care
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: email
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in an email contact\r\n* [Person](person.html): A value in an email contact\r\
\n* [Practitioner](practitioner.html): A value in an email contact\r\n*\
\ [PractitionerRole](practitionerrole.html): A value in an email contact\r\
\n* [RelatedPerson](relatedperson.html): A value in an email contact"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole/$validate:
get:
tags:
- PractitionerRole
summary: "GET: /PractitionerRole/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "PractitionerRole",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole/{id}/$validate:
get:
tags:
- PractitionerRole
summary: "GET: /PractitionerRole/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "PractitionerRole",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole/{id}/$meta-delete:
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole/{id}/$meta-add:
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole/$meta:
get:
tags:
- PractitionerRole
summary: "GET: /PractitionerRole/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole/{id}/$meta:
get:
tags:
- PractitionerRole
summary: "GET: /PractitionerRole/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole/$expunge:
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole/{id}/$expunge:
post:
tags:
- PractitionerRole
summary: "POST: /PractitionerRole/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/PractitionerRole/{id}/$diff:
get:
tags:
- PractitionerRole
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:
- PractitionerRole
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"
/Procedure/{id}:
get:
tags:
- Procedure
summary: "read-instance: Read Procedure instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Procedure
summary: "update-instance: Update an existing Procedure instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Procedure"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Procedure
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Procedure
summary: "instance-patch: Patch a resource instance of type Procedure by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Procedure/{id}/_history/{version_id}:
get:
tags:
- Procedure
summary: "vread-instance: Read Procedure instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Procedure:
get:
tags:
- Procedure
summary: "search-type: Search for Procedure instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: subject
in: query
description: Search by subject
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: part-of
in: query
description: Part of referenced event
required: false
schema:
type: string
- name: reason-code
in: query
description: Coded reason procedure performed
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: A request for this procedure
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: performer
in: query
description: The reference to the practitioner
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
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: reason-reference
in: query
description: The justification that the procedure was performed
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: Where the procedure happened
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: Classification of the procedure
required: false
schema:
type: string
- name: status
in: query
description: preparation | in-progress | not-done | on-hold | stopped | completed
| entered-in-error | unknown
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:
- Procedure
summary: "create-type: Create a new Procedure instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Procedure"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Procedure/_history:
get:
tags:
- Procedure
summary: "type-history: Fetch the resource change history for all resources\
\ of type Procedure"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Procedure/{id}/_history:
get:
tags:
- Procedure
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Procedure"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Procedure/_search:
get:
tags:
- Procedure
summary: "search-type: Search for Procedure instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: subject
in: query
description: Search by subject
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: part-of
in: query
description: Part of referenced event
required: false
schema:
type: string
- name: reason-code
in: query
description: Coded reason procedure performed
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: A request for this procedure
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: performer
in: query
description: The reference to the practitioner
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
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: reason-reference
in: query
description: The justification that the procedure was performed
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: location
in: query
description: Where the procedure happened
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: Classification of the procedure
required: false
schema:
type: string
- name: status
in: query
description: preparation | in-progress | not-done | on-hold | stopped | completed
| entered-in-error | unknown
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"
/Procedure/$validate:
get:
tags:
- Procedure
summary: "GET: /Procedure/$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:
- Procedure
summary: "POST: /Procedure/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Procedure",
"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"
/Procedure/{id}/$validate:
get:
tags:
- Procedure
summary: "GET: /Procedure/{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:
- Procedure
summary: "POST: /Procedure/{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": "Procedure",
"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"
/Procedure/{id}/$meta-delete:
post:
tags:
- Procedure
summary: "POST: /Procedure/{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"
/Procedure/{id}/$meta-add:
post:
tags:
- Procedure
summary: "POST: /Procedure/{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"
/Procedure/$meta:
get:
tags:
- Procedure
summary: "GET: /Procedure/$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:
- Procedure
summary: "POST: /Procedure/$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"
/Procedure/{id}/$meta:
get:
tags:
- Procedure
summary: "GET: /Procedure/{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:
- Procedure
summary: "POST: /Procedure/{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"
/Procedure/$expunge:
post:
tags:
- Procedure
summary: "POST: /Procedure/$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"
/Procedure/{id}/$expunge:
post:
tags:
- Procedure
summary: "POST: /Procedure/{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"
/Procedure/{id}/$diff:
get:
tags:
- Procedure
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:
- Procedure
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"
/Provenance/{id}:
get:
tags:
- Provenance
summary: "read-instance: Read Provenance instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Provenance
summary: "update-instance: Update an existing Provenance instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Provenance"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Provenance
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Provenance
summary: "instance-patch: Patch a resource instance of type Provenance by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Provenance/{id}/_history/{version_id}:
get:
tags:
- Provenance
summary: "vread-instance: Read Provenance instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Provenance:
get:
tags:
- Provenance
summary: "search-type: Search for Provenance instances"
description: This is a search type
parameters:
- name: agent-type
in: query
description: How the agent participated
required: false
schema:
type: string
- name: agent
in: query
description: Who participated
required: false
schema:
type: string
- name: signature-type
in: query
description: Indication of the reason the entity signed the object(s)
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: recorded
in: query
description: When the activity was recorded / updated
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: when
in: query
description: When the activity occurred
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: target
in: query
description: Target Reference(s) (usually version specific)
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: Target Reference(s) (usually version specific)
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: location
in: query
description: "Where the activity occurred, if relevant"
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: agent-role
in: query
description: What the agents role was
required: false
schema:
type: string
- name: entity
in: query
description: Identity of entity
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:
- Provenance
summary: "create-type: Create a new Provenance instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Provenance"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Provenance/_history:
get:
tags:
- Provenance
summary: "type-history: Fetch the resource change history for all resources\
\ of type Provenance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Provenance/{id}/_history:
get:
tags:
- Provenance
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Provenance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Provenance/_search:
get:
tags:
- Provenance
summary: "search-type: Search for Provenance instances"
description: This is a search type
parameters:
- name: agent-type
in: query
description: How the agent participated
required: false
schema:
type: string
- name: agent
in: query
description: Who participated
required: false
schema:
type: string
- name: signature-type
in: query
description: Indication of the reason the entity signed the object(s)
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: recorded
in: query
description: When the activity was recorded / updated
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: when
in: query
description: When the activity occurred
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: target
in: query
description: Target Reference(s) (usually version specific)
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: Target Reference(s) (usually version specific)
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: location
in: query
description: "Where the activity occurred, if relevant"
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: agent-role
in: query
description: What the agents role was
required: false
schema:
type: string
- name: entity
in: query
description: Identity of entity
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"
/Provenance/$validate:
get:
tags:
- Provenance
summary: "GET: /Provenance/$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:
- Provenance
summary: "POST: /Provenance/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Provenance",
"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"
/Provenance/{id}/$validate:
get:
tags:
- Provenance
summary: "GET: /Provenance/{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:
- Provenance
summary: "POST: /Provenance/{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": "Provenance",
"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"
/Provenance/{id}/$meta-delete:
post:
tags:
- Provenance
summary: "POST: /Provenance/{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"
/Provenance/{id}/$meta-add:
post:
tags:
- Provenance
summary: "POST: /Provenance/{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"
/Provenance/$meta:
get:
tags:
- Provenance
summary: "GET: /Provenance/$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:
- Provenance
summary: "POST: /Provenance/$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"
/Provenance/{id}/$meta:
get:
tags:
- Provenance
summary: "GET: /Provenance/{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:
- Provenance
summary: "POST: /Provenance/{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"
/Provenance/$expunge:
post:
tags:
- Provenance
summary: "POST: /Provenance/$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"
/Provenance/{id}/$expunge:
post:
tags:
- Provenance
summary: "POST: /Provenance/{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"
/Provenance/{id}/$diff:
get:
tags:
- Provenance
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:
- Provenance
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"
/Questionnaire/{id}:
get:
tags:
- Questionnaire
summary: "read-instance: Read Questionnaire instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Questionnaire
summary: "update-instance: Update an existing Questionnaire instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Questionnaire"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Questionnaire
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Questionnaire
summary: "instance-patch: Patch a resource instance of type Questionnaire by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Questionnaire/{id}/_history/{version_id}:
get:
tags:
- Questionnaire
summary: "vread-instance: Read Questionnaire instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Questionnaire:
get:
tags:
- Questionnaire
summary: "search-type: Search for Questionnaire instances"
description: This is a search type
parameters:
- name: date
in: query
description: The questionnaire publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: A code that corresponds to one of its items in the questionnaire
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the questionnaire
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the questionnaire
required: false
schema:
type: string
- name: description
in: query
description: The description of the questionnaire
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the questionnaire
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the questionnaire
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: A quantity- or range-valued use context assigned to the questionnaire
required: false
schema:
anyOf:
- type: string
- type: number
- name: effective
in: query
description: The time during which the questionnaire is intended to be in
use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the questionnaire
required: false
schema:
type: string
- name: definition
in: query
description: ElementDefinition - details for the item
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the questionnaire
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the questionnaire
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: The business version of the questionnaire
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the questionnaire
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: subject-type
in: query
description: Resource that can be subject of QuestionnaireResponse
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: Computationally friendly name of the questionnaire
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the questionnaire
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 questionnaire
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:
- Questionnaire
summary: "create-type: Create a new Questionnaire instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Questionnaire"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Questionnaire/_history:
get:
tags:
- Questionnaire
summary: "type-history: Fetch the resource change history for all resources\
\ of type Questionnaire"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Questionnaire/{id}/_history:
get:
tags:
- Questionnaire
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Questionnaire"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Questionnaire/_search:
get:
tags:
- Questionnaire
summary: "search-type: Search for Questionnaire instances"
description: This is a search type
parameters:
- name: date
in: query
description: The questionnaire publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: A code that corresponds to one of its items in the questionnaire
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the questionnaire
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the questionnaire
required: false
schema:
type: string
- name: description
in: query
description: The description of the questionnaire
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the questionnaire
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the questionnaire
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: A quantity- or range-valued use context assigned to the questionnaire
required: false
schema:
anyOf:
- type: string
- type: number
- name: effective
in: query
description: The time during which the questionnaire is intended to be in
use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the questionnaire
required: false
schema:
type: string
- name: definition
in: query
description: ElementDefinition - details for the item
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the questionnaire
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the questionnaire
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: The business version of the questionnaire
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the questionnaire
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: subject-type
in: query
description: Resource that can be subject of QuestionnaireResponse
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: Computationally friendly name of the questionnaire
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the questionnaire
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 questionnaire
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"
/Questionnaire/$validate:
get:
tags:
- Questionnaire
summary: "GET: /Questionnaire/$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:
- Questionnaire
summary: "POST: /Questionnaire/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Questionnaire",
"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"
/Questionnaire/{id}/$validate:
get:
tags:
- Questionnaire
summary: "GET: /Questionnaire/{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:
- Questionnaire
summary: "POST: /Questionnaire/{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": "Questionnaire",
"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"
/Questionnaire/{id}/$meta-delete:
post:
tags:
- Questionnaire
summary: "POST: /Questionnaire/{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"
/Questionnaire/{id}/$meta-add:
post:
tags:
- Questionnaire
summary: "POST: /Questionnaire/{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"
/Questionnaire/$meta:
get:
tags:
- Questionnaire
summary: "GET: /Questionnaire/$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:
- Questionnaire
summary: "POST: /Questionnaire/$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"
/Questionnaire/{id}/$meta:
get:
tags:
- Questionnaire
summary: "GET: /Questionnaire/{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:
- Questionnaire
summary: "POST: /Questionnaire/{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"
/Questionnaire/$expunge:
post:
tags:
- Questionnaire
summary: "POST: /Questionnaire/$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"
/Questionnaire/{id}/$expunge:
post:
tags:
- Questionnaire
summary: "POST: /Questionnaire/{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"
/Questionnaire/{id}/$diff:
get:
tags:
- Questionnaire
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:
- Questionnaire
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"
/QuestionnaireResponse/{id}:
get:
tags:
- QuestionnaireResponse
summary: "read-instance: Read QuestionnaireResponse instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- QuestionnaireResponse
summary: "update-instance: Update an existing QuestionnaireResponse instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "QuestionnaireResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- QuestionnaireResponse
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- QuestionnaireResponse
summary: "instance-patch: Patch a resource instance of type QuestionnaireResponse\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/QuestionnaireResponse/{id}/_history/{version_id}:
get:
tags:
- QuestionnaireResponse
summary: "vread-instance: Read QuestionnaireResponse instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/QuestionnaireResponse:
get:
tags:
- QuestionnaireResponse
summary: "search-type: Search for QuestionnaireResponse instances"
description: This is a search type
parameters:
- name: authored
in: query
description: When the questionnaire response was last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: The unique identifier for the questionnaire response
required: false
schema:
type: string
- name: questionnaire
in: query
description: The questionnaire the answers are provided for
required: false
schema:
type: string
- name: author
in: query
description: The author of the questionnaire response
required: false
schema:
type: string
- name: subject
in: query
description: The subject of the questionnaire response
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: part-of
in: query
description: Procedure or observation this questionnaire response was performed
as a part of
required: false
schema:
type: string
- name: encounter
in: query
description: Encounter associated with the questionnaire response
required: false
schema:
type: string
- name: source
in: query
description: The individual providing the information reflected in the questionnaire
respose
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: based-on
in: query
description: Plan/proposal/order fulfilled by this questionnaire response
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 that is the subject of the questionnaire response
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 questionnaire response
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:
- QuestionnaireResponse
summary: "create-type: Create a new QuestionnaireResponse instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "QuestionnaireResponse"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/QuestionnaireResponse/_history:
get:
tags:
- QuestionnaireResponse
summary: "type-history: Fetch the resource change history for all resources\
\ of type QuestionnaireResponse"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/QuestionnaireResponse/{id}/_history:
get:
tags:
- QuestionnaireResponse
summary: "instance-history: Fetch the resource change history for all resources\
\ of type QuestionnaireResponse"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/QuestionnaireResponse/_search:
get:
tags:
- QuestionnaireResponse
summary: "search-type: Search for QuestionnaireResponse instances"
description: This is a search type
parameters:
- name: authored
in: query
description: When the questionnaire response was last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: The unique identifier for the questionnaire response
required: false
schema:
type: string
- name: questionnaire
in: query
description: The questionnaire the answers are provided for
required: false
schema:
type: string
- name: author
in: query
description: The author of the questionnaire response
required: false
schema:
type: string
- name: subject
in: query
description: The subject of the questionnaire response
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: part-of
in: query
description: Procedure or observation this questionnaire response was performed
as a part of
required: false
schema:
type: string
- name: encounter
in: query
description: Encounter associated with the questionnaire response
required: false
schema:
type: string
- name: source
in: query
description: The individual providing the information reflected in the questionnaire
respose
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: based-on
in: query
description: Plan/proposal/order fulfilled by this questionnaire response
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 that is the subject of the questionnaire response
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 questionnaire response
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"
/QuestionnaireResponse/$validate:
get:
tags:
- QuestionnaireResponse
summary: "GET: /QuestionnaireResponse/$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:
- QuestionnaireResponse
summary: "POST: /QuestionnaireResponse/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "QuestionnaireResponse",
"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"
/QuestionnaireResponse/{id}/$validate:
get:
tags:
- QuestionnaireResponse
summary: "GET: /QuestionnaireResponse/{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:
- QuestionnaireResponse
summary: "POST: /QuestionnaireResponse/{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": "QuestionnaireResponse",
"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"
/QuestionnaireResponse/{id}/$meta-delete:
post:
tags:
- QuestionnaireResponse
summary: "POST: /QuestionnaireResponse/{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"
/QuestionnaireResponse/{id}/$meta-add:
post:
tags:
- QuestionnaireResponse
summary: "POST: /QuestionnaireResponse/{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"
/QuestionnaireResponse/$meta:
get:
tags:
- QuestionnaireResponse
summary: "GET: /QuestionnaireResponse/$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:
- QuestionnaireResponse
summary: "POST: /QuestionnaireResponse/$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"
/QuestionnaireResponse/{id}/$meta:
get:
tags:
- QuestionnaireResponse
summary: "GET: /QuestionnaireResponse/{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:
- QuestionnaireResponse
summary: "POST: /QuestionnaireResponse/{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"
/QuestionnaireResponse/$expunge:
post:
tags:
- QuestionnaireResponse
summary: "POST: /QuestionnaireResponse/$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"
/QuestionnaireResponse/{id}/$expunge:
post:
tags:
- QuestionnaireResponse
summary: "POST: /QuestionnaireResponse/{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"
/QuestionnaireResponse/{id}/$diff:
get:
tags:
- QuestionnaireResponse
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:
- QuestionnaireResponse
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"
/RelatedPerson/{id}:
get:
tags:
- RelatedPerson
summary: "read-instance: Read RelatedPerson instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- RelatedPerson
summary: "update-instance: Update an existing RelatedPerson instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "RelatedPerson"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- RelatedPerson
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- RelatedPerson
summary: "instance-patch: Patch a resource instance of type RelatedPerson by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RelatedPerson/{id}/_history/{version_id}:
get:
tags:
- RelatedPerson
summary: "vread-instance: Read RelatedPerson instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RelatedPerson:
get:
tags:
- RelatedPerson
summary: "search-type: Search for RelatedPerson instances"
description: This is a search type
parameters:
- name: birthdate
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's\
\ date of birth\r\n* [Person](person.html): The person's date of birth\r\
\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: address-state
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state\
\ specified in an address\r\n* [Person](person.html): A state specified\
\ in an address\r\n* [Practitioner](practitioner.html): A state specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A state specified\
\ in an address"
required: false
schema:
type: string
- name: gender
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender\
\ of the patient\r\n* [Person](person.html): The gender of the person\r\n\
* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html):\
\ Gender of the related person"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: address-country
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country\
\ specified in an address\r\n* [Person](person.html): A country specified\
\ in an address\r\n* [Practitioner](practitioner.html): A country specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A country specified\
\ in an address"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: phonetic
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of either family or given name using some kind of phonetic matching algorithm\r\
\n* [Person](person.html): A portion of name using some kind of phonetic\
\ matching algorithm\r\n* [Practitioner](practitioner.html): A portion of\
\ either family or given name using some kind of phonetic matching algorithm\r\
\n* [RelatedPerson](relatedperson.html): A portion of name using some kind\
\ of phonetic matching algorithm"
required: false
schema:
type: string
- name: patient
in: query
description: The patient this related person is related to
required: false
schema:
type: string
- name: telecom
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\
\ in any kind of telecom details of the patient\r\n* [Person](person.html):\
\ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\
\ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact"
required: false
schema:
type: string
- name: address-city
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city\
\ specified in an address\r\n* [Person](person.html): A city specified in\
\ an address\r\n* [Practitioner](practitioner.html): A city specified in\
\ an address\r\n* [RelatedPerson](relatedperson.html): A city specified\
\ in an address"
required: false
schema:
type: string
- name: relationship
in: query
description: The relationship between the patient and the relatedperson
required: false
schema:
type: string
- name: email
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in an email contact\r\n* [Person](person.html): A value in an email contact\r\
\n* [Practitioner](practitioner.html): A value in an email contact\r\n*\
\ [PractitionerRole](practitionerrole.html): A value in an email contact\r\
\n* [RelatedPerson](relatedperson.html): A value in an email contact"
required: false
schema:
type: string
- name: identifier
in: query
description: An Identifier of the RelatedPerson
required: false
schema:
type: string
- name: address
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server\
\ defined search that may match any of the string fields in the Address,\
\ including line, city, district, state, country, postalCode, and/or text\r\
\n* [Person](person.html): A server defined search that may match any of\
\ the string fields in the Address, including line, city, district, state,\
\ country, postalCode, and/or text\r\n* [Practitioner](practitioner.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text\r\n* [RelatedPerson](relatedperson.html): A server defined search\
\ that may match any of the string fields in the Address, including line,\
\ city, district, state, country, postalCode, and/or text"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Indicates if the related person record is active
required: false
schema:
type: string
- name: address-postalcode
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode\
\ specified in an address\r\n* [Person](person.html): A postal code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A postalCode specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A postal code\
\ specified in an address"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: phone
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\
\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A\
\ value in a phone contact"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use\
\ code specified in an address\r\n* [Person](person.html): A use code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A use code specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified\
\ in an address"
required: false
schema:
type: string
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
\ text"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- RelatedPerson
summary: "create-type: Create a new RelatedPerson instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "RelatedPerson"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RelatedPerson/_history:
get:
tags:
- RelatedPerson
summary: "type-history: Fetch the resource change history for all resources\
\ of type RelatedPerson"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RelatedPerson/{id}/_history:
get:
tags:
- RelatedPerson
summary: "instance-history: Fetch the resource change history for all resources\
\ of type RelatedPerson"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RelatedPerson/_search:
get:
tags:
- RelatedPerson
summary: "search-type: Search for RelatedPerson instances"
description: This is a search type
parameters:
- name: birthdate
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's\
\ date of birth\r\n* [Person](person.html): The person's date of birth\r\
\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: address-state
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state\
\ specified in an address\r\n* [Person](person.html): A state specified\
\ in an address\r\n* [Practitioner](practitioner.html): A state specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A state specified\
\ in an address"
required: false
schema:
type: string
- name: gender
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender\
\ of the patient\r\n* [Person](person.html): The gender of the person\r\n\
* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html):\
\ Gender of the related person"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: address-country
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country\
\ specified in an address\r\n* [Person](person.html): A country specified\
\ in an address\r\n* [Practitioner](practitioner.html): A country specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A country specified\
\ in an address"
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: phonetic
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion\
\ of either family or given name using some kind of phonetic matching algorithm\r\
\n* [Person](person.html): A portion of name using some kind of phonetic\
\ matching algorithm\r\n* [Practitioner](practitioner.html): A portion of\
\ either family or given name using some kind of phonetic matching algorithm\r\
\n* [RelatedPerson](relatedperson.html): A portion of name using some kind\
\ of phonetic matching algorithm"
required: false
schema:
type: string
- name: patient
in: query
description: The patient this related person is related to
required: false
schema:
type: string
- name: telecom
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value\
\ in any kind of telecom details of the patient\r\n* [Person](person.html):\
\ The value in any kind of contact\r\n* [Practitioner](practitioner.html):\
\ The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html):\
\ The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html):\
\ The value in any kind of contact"
required: false
schema:
type: string
- name: address-city
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city\
\ specified in an address\r\n* [Person](person.html): A city specified in\
\ an address\r\n* [Practitioner](practitioner.html): A city specified in\
\ an address\r\n* [RelatedPerson](relatedperson.html): A city specified\
\ in an address"
required: false
schema:
type: string
- name: relationship
in: query
description: The relationship between the patient and the relatedperson
required: false
schema:
type: string
- name: email
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in an email contact\r\n* [Person](person.html): A value in an email contact\r\
\n* [Practitioner](practitioner.html): A value in an email contact\r\n*\
\ [PractitionerRole](practitionerrole.html): A value in an email contact\r\
\n* [RelatedPerson](relatedperson.html): A value in an email contact"
required: false
schema:
type: string
- name: identifier
in: query
description: An Identifier of the RelatedPerson
required: false
schema:
type: string
- name: address
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server\
\ defined search that may match any of the string fields in the Address,\
\ including line, city, district, state, country, postalCode, and/or text\r\
\n* [Person](person.html): A server defined search that may match any of\
\ the string fields in the Address, including line, city, district, state,\
\ country, postalCode, and/or text\r\n* [Practitioner](practitioner.html):\
\ A server defined search that may match any of the string fields in the\
\ Address, including line, city, district, state, country, postalCode, and/or\
\ text\r\n* [RelatedPerson](relatedperson.html): A server defined search\
\ that may match any of the string fields in the Address, including line,\
\ city, district, state, country, postalCode, and/or text"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Indicates if the related person record is active
required: false
schema:
type: string
- name: address-postalcode
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode\
\ specified in an address\r\n* [Person](person.html): A postal code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A postalCode specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A postal code\
\ specified in an address"
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: phone
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value\
\ in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\
\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html):\
\ A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A\
\ value in a phone contact"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: address-use
in: query
description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use\
\ code specified in an address\r\n* [Person](person.html): A use code specified\
\ in an address\r\n* [Practitioner](practitioner.html): A use code specified\
\ in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified\
\ in an address"
required: false
schema:
type: string
- name: name
in: query
description: "A server defined search that may match any of the string fields\
\ in the HumanName, including family, give, prefix, suffix, suffix, and/or\
\ text"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RelatedPerson/$validate:
get:
tags:
- RelatedPerson
summary: "GET: /RelatedPerson/$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:
- RelatedPerson
summary: "POST: /RelatedPerson/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "RelatedPerson",
"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"
/RelatedPerson/{id}/$validate:
get:
tags:
- RelatedPerson
summary: "GET: /RelatedPerson/{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:
- RelatedPerson
summary: "POST: /RelatedPerson/{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": "RelatedPerson",
"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"
/RelatedPerson/{id}/$meta-delete:
post:
tags:
- RelatedPerson
summary: "POST: /RelatedPerson/{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"
/RelatedPerson/{id}/$meta-add:
post:
tags:
- RelatedPerson
summary: "POST: /RelatedPerson/{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"
/RelatedPerson/$meta:
get:
tags:
- RelatedPerson
summary: "GET: /RelatedPerson/$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:
- RelatedPerson
summary: "POST: /RelatedPerson/$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"
/RelatedPerson/{id}/$meta:
get:
tags:
- RelatedPerson
summary: "GET: /RelatedPerson/{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:
- RelatedPerson
summary: "POST: /RelatedPerson/{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"
/RelatedPerson/$expunge:
post:
tags:
- RelatedPerson
summary: "POST: /RelatedPerson/$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"
/RelatedPerson/{id}/$expunge:
post:
tags:
- RelatedPerson
summary: "POST: /RelatedPerson/{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"
/RelatedPerson/{id}/$diff:
get:
tags:
- RelatedPerson
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:
- RelatedPerson
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"
/RequestGroup/{id}:
get:
tags:
- RequestGroup
summary: "read-instance: Read RequestGroup instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- RequestGroup
summary: "update-instance: Update an existing RequestGroup instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "RequestGroup"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- RequestGroup
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- RequestGroup
summary: "instance-patch: Patch a resource instance of type RequestGroup by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RequestGroup/{id}/_history/{version_id}:
get:
tags:
- RequestGroup
summary: "vread-instance: Read RequestGroup instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RequestGroup:
get:
tags:
- RequestGroup
summary: "search-type: Search for RequestGroup instances"
description: This is a search type
parameters:
- name: authored
in: query
description: The date the request group was authored
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: External identifiers for the request group
required: false
schema:
type: string
- name: code
in: query
description: The code of the request group
required: false
schema:
type: string
- name: author
in: query
description: The author of the request group
required: false
schema:
type: string
- name: subject
in: query
description: The subject that the request group is about
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: instantiates-canonical
in: query
description: The FHIR-based definition from which the request group is realized
required: false
schema:
type: string
- name: encounter
in: query
description: The encounter the request group applies to
required: false
schema:
type: string
- name: priority
in: query
description: The priority of the request group
required: false
schema:
type: string
- name: intent
in: query
description: The intent of the request group
required: false
schema:
type: string
- name: participant
in: query
description: The participant in the requests in the group
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: group-identifier
in: query
description: The group identifier for the request group
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 identity of a patient to search for request groups
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: instantiates-uri
in: query
description: The external definition from which the request group is realized
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 request group
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:
- RequestGroup
summary: "create-type: Create a new RequestGroup instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "RequestGroup"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RequestGroup/_history:
get:
tags:
- RequestGroup
summary: "type-history: Fetch the resource change history for all resources\
\ of type RequestGroup"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RequestGroup/{id}/_history:
get:
tags:
- RequestGroup
summary: "instance-history: Fetch the resource change history for all resources\
\ of type RequestGroup"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RequestGroup/_search:
get:
tags:
- RequestGroup
summary: "search-type: Search for RequestGroup instances"
description: This is a search type
parameters:
- name: authored
in: query
description: The date the request group was authored
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: External identifiers for the request group
required: false
schema:
type: string
- name: code
in: query
description: The code of the request group
required: false
schema:
type: string
- name: author
in: query
description: The author of the request group
required: false
schema:
type: string
- name: subject
in: query
description: The subject that the request group is about
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: instantiates-canonical
in: query
description: The FHIR-based definition from which the request group is realized
required: false
schema:
type: string
- name: encounter
in: query
description: The encounter the request group applies to
required: false
schema:
type: string
- name: priority
in: query
description: The priority of the request group
required: false
schema:
type: string
- name: intent
in: query
description: The intent of the request group
required: false
schema:
type: string
- name: participant
in: query
description: The participant in the requests in the group
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: group-identifier
in: query
description: The group identifier for the request group
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 identity of a patient to search for request groups
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: instantiates-uri
in: query
description: The external definition from which the request group is realized
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 request group
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"
/RequestGroup/$validate:
get:
tags:
- RequestGroup
summary: "GET: /RequestGroup/$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:
- RequestGroup
summary: "POST: /RequestGroup/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "RequestGroup",
"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"
/RequestGroup/{id}/$validate:
get:
tags:
- RequestGroup
summary: "GET: /RequestGroup/{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:
- RequestGroup
summary: "POST: /RequestGroup/{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": "RequestGroup",
"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"
/RequestGroup/{id}/$meta-delete:
post:
tags:
- RequestGroup
summary: "POST: /RequestGroup/{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"
/RequestGroup/{id}/$meta-add:
post:
tags:
- RequestGroup
summary: "POST: /RequestGroup/{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"
/RequestGroup/$meta:
get:
tags:
- RequestGroup
summary: "GET: /RequestGroup/$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:
- RequestGroup
summary: "POST: /RequestGroup/$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"
/RequestGroup/{id}/$meta:
get:
tags:
- RequestGroup
summary: "GET: /RequestGroup/{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:
- RequestGroup
summary: "POST: /RequestGroup/{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"
/RequestGroup/$expunge:
post:
tags:
- RequestGroup
summary: "POST: /RequestGroup/$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"
/RequestGroup/{id}/$expunge:
post:
tags:
- RequestGroup
summary: "POST: /RequestGroup/{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"
/RequestGroup/{id}/$diff:
get:
tags:
- RequestGroup
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:
- RequestGroup
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"
/ResearchDefinition/{id}:
get:
tags:
- ResearchDefinition
summary: "read-instance: Read ResearchDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ResearchDefinition
summary: "update-instance: Update an existing ResearchDefinition 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": "ResearchDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- ResearchDefinition
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:
- ResearchDefinition
summary: "instance-patch: Patch a resource instance of type ResearchDefinition\
\ 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"
/ResearchDefinition/{id}/_history/{version_id}:
get:
tags:
- ResearchDefinition
summary: "vread-instance: Read ResearchDefinition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchDefinition:
get:
tags:
- ResearchDefinition
summary: "search-type: Search for ResearchDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The research definition publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the research definition
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the research definition
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the research definition
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the research definition
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the research definition
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: A quantity- or range-valued use context assigned to the research
definition
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the research definition is intended to
be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the research definition
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the research definition
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the research definition
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: The business version of the research definition
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the research definition
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: Computationally friendly name of the research definition
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the research definition
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the ResearchDefinition
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 research definition
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:
- ResearchDefinition
summary: "create-type: Create a new ResearchDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ResearchDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchDefinition/_history:
get:
tags:
- ResearchDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type ResearchDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchDefinition/{id}/_history:
get:
tags:
- ResearchDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ResearchDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchDefinition/_search:
get:
tags:
- ResearchDefinition
summary: "search-type: Search for ResearchDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The research definition publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the research definition
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the research definition
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the research definition
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the research definition
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the research definition
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: A quantity- or range-valued use context assigned to the research
definition
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the research definition is intended to
be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the research definition
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the research definition
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the research definition
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: The business version of the research definition
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the research definition
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: Computationally friendly name of the research definition
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the research definition
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the ResearchDefinition
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 research definition
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"
/ResearchDefinition/$validate:
get:
tags:
- ResearchDefinition
summary: "GET: /ResearchDefinition/$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:
- ResearchDefinition
summary: "POST: /ResearchDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ResearchDefinition",
"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"
/ResearchDefinition/{id}/$validate:
get:
tags:
- ResearchDefinition
summary: "GET: /ResearchDefinition/{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:
- ResearchDefinition
summary: "POST: /ResearchDefinition/{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": "ResearchDefinition",
"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"
/ResearchDefinition/{id}/$meta-delete:
post:
tags:
- ResearchDefinition
summary: "POST: /ResearchDefinition/{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"
/ResearchDefinition/{id}/$meta-add:
post:
tags:
- ResearchDefinition
summary: "POST: /ResearchDefinition/{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"
/ResearchDefinition/$meta:
get:
tags:
- ResearchDefinition
summary: "GET: /ResearchDefinition/$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:
- ResearchDefinition
summary: "POST: /ResearchDefinition/$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"
/ResearchDefinition/{id}/$meta:
get:
tags:
- ResearchDefinition
summary: "GET: /ResearchDefinition/{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:
- ResearchDefinition
summary: "POST: /ResearchDefinition/{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"
/ResearchDefinition/$expunge:
post:
tags:
- ResearchDefinition
summary: "POST: /ResearchDefinition/$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"
/ResearchDefinition/{id}/$expunge:
post:
tags:
- ResearchDefinition
summary: "POST: /ResearchDefinition/{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"
/ResearchDefinition/{id}/$diff:
get:
tags:
- ResearchDefinition
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:
- ResearchDefinition
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"
/ResearchElementDefinition/{id}:
get:
tags:
- ResearchElementDefinition
summary: "read-instance: Read ResearchElementDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ResearchElementDefinition
summary: "update-instance: Update an existing ResearchElementDefinition 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": "ResearchElementDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- ResearchElementDefinition
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:
- ResearchElementDefinition
summary: "instance-patch: Patch a resource instance of type ResearchElementDefinition\
\ 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"
/ResearchElementDefinition/{id}/_history/{version_id}:
get:
tags:
- ResearchElementDefinition
summary: "vread-instance: Read ResearchElementDefinition instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchElementDefinition:
get:
tags:
- ResearchElementDefinition
summary: "search-type: Search for ResearchElementDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The research element definition publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the research element
definition
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the research element definition
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the research element definition
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the research element definition
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the research element definition
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: A quantity- or range-valued use context assigned to the research
element definition
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the research element definition is intended
to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the research element definition
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the research element definition
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the research element definition
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: The business version of the research element definition
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the research element definition
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: Computationally friendly name of the research element definition
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the research element definition
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the ResearchElementDefinition
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 research element definition
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:
- ResearchElementDefinition
summary: "create-type: Create a new ResearchElementDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ResearchElementDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchElementDefinition/_history:
get:
tags:
- ResearchElementDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type ResearchElementDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchElementDefinition/{id}/_history:
get:
tags:
- ResearchElementDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ResearchElementDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchElementDefinition/_search:
get:
tags:
- ResearchElementDefinition
summary: "search-type: Search for ResearchElementDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: The research element definition publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: successor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: context-type-value
in: query
description: A use context type and value assigned to the research element
definition
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the research element definition
required: false
schema:
type: string
- name: derived-from
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: description
in: query
description: The description of the research element definition
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the research element definition
required: false
schema:
type: string
- name: predecessor
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: composed-of
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the research element definition
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: A quantity- or range-valued use context assigned to the research
element definition
required: false
schema:
anyOf:
- type: string
- type: number
- name: depends-on
in: query
description: What resource is being referenced
required: false
schema:
type: string
- name: effective
in: query
description: The time during which the research element definition is intended
to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the research element definition
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the research element definition
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the research element definition
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: The business version of the research element definition
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the research element definition
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: Computationally friendly name of the research element definition
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the research element definition
required: false
schema:
type: string
- name: topic
in: query
description: Topics associated with the ResearchElementDefinition
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 research element definition
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"
/ResearchElementDefinition/$validate:
get:
tags:
- ResearchElementDefinition
summary: "GET: /ResearchElementDefinition/$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:
- ResearchElementDefinition
summary: "POST: /ResearchElementDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ResearchElementDefinition",
"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"
/ResearchElementDefinition/{id}/$validate:
get:
tags:
- ResearchElementDefinition
summary: "GET: /ResearchElementDefinition/{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:
- ResearchElementDefinition
summary: "POST: /ResearchElementDefinition/{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": "ResearchElementDefinition",
"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"
/ResearchElementDefinition/{id}/$meta-delete:
post:
tags:
- ResearchElementDefinition
summary: "POST: /ResearchElementDefinition/{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"
/ResearchElementDefinition/{id}/$meta-add:
post:
tags:
- ResearchElementDefinition
summary: "POST: /ResearchElementDefinition/{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"
/ResearchElementDefinition/$meta:
get:
tags:
- ResearchElementDefinition
summary: "GET: /ResearchElementDefinition/$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:
- ResearchElementDefinition
summary: "POST: /ResearchElementDefinition/$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"
/ResearchElementDefinition/{id}/$meta:
get:
tags:
- ResearchElementDefinition
summary: "GET: /ResearchElementDefinition/{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:
- ResearchElementDefinition
summary: "POST: /ResearchElementDefinition/{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"
/ResearchElementDefinition/$expunge:
post:
tags:
- ResearchElementDefinition
summary: "POST: /ResearchElementDefinition/$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"
/ResearchElementDefinition/{id}/$expunge:
post:
tags:
- ResearchElementDefinition
summary: "POST: /ResearchElementDefinition/{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"
/ResearchElementDefinition/{id}/$diff:
get:
tags:
- ResearchElementDefinition
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:
- ResearchElementDefinition
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"
/ResearchStudy/{id}:
get:
tags:
- ResearchStudy
summary: "read-instance: Read ResearchStudy instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ResearchStudy
summary: "update-instance: Update an existing ResearchStudy instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ResearchStudy"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- ResearchStudy
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- ResearchStudy
summary: "instance-patch: Patch a resource instance of type ResearchStudy by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchStudy/{id}/_history/{version_id}:
get:
tags:
- ResearchStudy
summary: "vread-instance: Read ResearchStudy instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchStudy:
get:
tags:
- ResearchStudy
summary: "search-type: Search for ResearchStudy instances"
description: This is a search type
parameters:
- name: date
in: query
description: When the study began and ended
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: Business Identifier for study
required: false
schema:
type: string
- name: partof
in: query
description: Part of larger study
required: false
schema:
type: string
- name: sponsor
in: query
description: Organization that initiates and is legally responsible for the
study
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: focus
in: query
description: "Drugs, devices, etc. under study"
required: false
schema:
type: string
- name: principalinvestigator
in: query
description: Researcher who oversees multiple aspects of the study
required: false
schema:
type: string
- name: title
in: query
description: Name for this study
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: protocol
in: query
description: Steps followed in executing study
required: false
schema:
type: string
- name: site
in: query
description: Facility where study activities are conducted
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: location
in: query
description: Geographic region(s) for study
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: Classifications for the study
required: false
schema:
type: string
- name: keyword
in: query
description: Used to search for the study
required: false
schema:
type: string
- name: status
in: query
description: active | administratively-completed | approved | closed-to-accrual
| closed-to-accrual-and-intervention | completed | disapproved | in-review
| temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention
| withdrawn
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:
- ResearchStudy
summary: "create-type: Create a new ResearchStudy instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ResearchStudy"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchStudy/_history:
get:
tags:
- ResearchStudy
summary: "type-history: Fetch the resource change history for all resources\
\ of type ResearchStudy"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchStudy/{id}/_history:
get:
tags:
- ResearchStudy
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ResearchStudy"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchStudy/_search:
get:
tags:
- ResearchStudy
summary: "search-type: Search for ResearchStudy instances"
description: This is a search type
parameters:
- name: date
in: query
description: When the study began and ended
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: Business Identifier for study
required: false
schema:
type: string
- name: partof
in: query
description: Part of larger study
required: false
schema:
type: string
- name: sponsor
in: query
description: Organization that initiates and is legally responsible for the
study
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: focus
in: query
description: "Drugs, devices, etc. under study"
required: false
schema:
type: string
- name: principalinvestigator
in: query
description: Researcher who oversees multiple aspects of the study
required: false
schema:
type: string
- name: title
in: query
description: Name for this study
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: protocol
in: query
description: Steps followed in executing study
required: false
schema:
type: string
- name: site
in: query
description: Facility where study activities are conducted
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: location
in: query
description: Geographic region(s) for study
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: Classifications for the study
required: false
schema:
type: string
- name: keyword
in: query
description: Used to search for the study
required: false
schema:
type: string
- name: status
in: query
description: active | administratively-completed | approved | closed-to-accrual
| closed-to-accrual-and-intervention | completed | disapproved | in-review
| temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention
| withdrawn
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"
/ResearchStudy/$validate:
get:
tags:
- ResearchStudy
summary: "GET: /ResearchStudy/$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:
- ResearchStudy
summary: "POST: /ResearchStudy/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ResearchStudy",
"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"
/ResearchStudy/{id}/$validate:
get:
tags:
- ResearchStudy
summary: "GET: /ResearchStudy/{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:
- ResearchStudy
summary: "POST: /ResearchStudy/{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": "ResearchStudy",
"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"
/ResearchStudy/{id}/$meta-delete:
post:
tags:
- ResearchStudy
summary: "POST: /ResearchStudy/{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"
/ResearchStudy/{id}/$meta-add:
post:
tags:
- ResearchStudy
summary: "POST: /ResearchStudy/{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"
/ResearchStudy/$meta:
get:
tags:
- ResearchStudy
summary: "GET: /ResearchStudy/$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:
- ResearchStudy
summary: "POST: /ResearchStudy/$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"
/ResearchStudy/{id}/$meta:
get:
tags:
- ResearchStudy
summary: "GET: /ResearchStudy/{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:
- ResearchStudy
summary: "POST: /ResearchStudy/{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"
/ResearchStudy/$expunge:
post:
tags:
- ResearchStudy
summary: "POST: /ResearchStudy/$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"
/ResearchStudy/{id}/$expunge:
post:
tags:
- ResearchStudy
summary: "POST: /ResearchStudy/{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"
/ResearchStudy/{id}/$diff:
get:
tags:
- ResearchStudy
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:
- ResearchStudy
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"
/ResearchSubject/{id}:
get:
tags:
- ResearchSubject
summary: "read-instance: Read ResearchSubject instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ResearchSubject
summary: "update-instance: Update an existing ResearchSubject instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ResearchSubject"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- ResearchSubject
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- ResearchSubject
summary: "instance-patch: Patch a resource instance of type ResearchSubject\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchSubject/{id}/_history/{version_id}:
get:
tags:
- ResearchSubject
summary: "vread-instance: Read ResearchSubject instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchSubject:
get:
tags:
- ResearchSubject
summary: "search-type: Search for ResearchSubject instances"
description: This is a search type
parameters:
- name: date
in: query
description: Start and end of participation
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: Business Identifier for research subject in a study
required: false
schema:
type: string
- name: study
in: query
description: Study subject is part of
required: false
schema:
type: string
- name: individual
in: query
description: Who is part of study
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: Who is part of study
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: candidate | eligible | follow-up | ineligible | not-registered
| off-study | on-study | on-study-intervention | on-study-observation |
pending-on-study | potential-candidate | screening | withdrawn
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:
- ResearchSubject
summary: "create-type: Create a new ResearchSubject instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ResearchSubject"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchSubject/_history:
get:
tags:
- ResearchSubject
summary: "type-history: Fetch the resource change history for all resources\
\ of type ResearchSubject"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchSubject/{id}/_history:
get:
tags:
- ResearchSubject
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ResearchSubject"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ResearchSubject/_search:
get:
tags:
- ResearchSubject
summary: "search-type: Search for ResearchSubject instances"
description: This is a search type
parameters:
- name: date
in: query
description: Start and end of participation
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: Business Identifier for research subject in a study
required: false
schema:
type: string
- name: study
in: query
description: Study subject is part of
required: false
schema:
type: string
- name: individual
in: query
description: Who is part of study
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: Who is part of study
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: candidate | eligible | follow-up | ineligible | not-registered
| off-study | on-study | on-study-intervention | on-study-observation |
pending-on-study | potential-candidate | screening | withdrawn
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"
/ResearchSubject/$validate:
get:
tags:
- ResearchSubject
summary: "GET: /ResearchSubject/$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:
- ResearchSubject
summary: "POST: /ResearchSubject/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ResearchSubject",
"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"
/ResearchSubject/{id}/$validate:
get:
tags:
- ResearchSubject
summary: "GET: /ResearchSubject/{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:
- ResearchSubject
summary: "POST: /ResearchSubject/{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": "ResearchSubject",
"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"
/ResearchSubject/{id}/$meta-delete:
post:
tags:
- ResearchSubject
summary: "POST: /ResearchSubject/{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"
/ResearchSubject/{id}/$meta-add:
post:
tags:
- ResearchSubject
summary: "POST: /ResearchSubject/{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"
/ResearchSubject/$meta:
get:
tags:
- ResearchSubject
summary: "GET: /ResearchSubject/$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:
- ResearchSubject
summary: "POST: /ResearchSubject/$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"
/ResearchSubject/{id}/$meta:
get:
tags:
- ResearchSubject
summary: "GET: /ResearchSubject/{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:
- ResearchSubject
summary: "POST: /ResearchSubject/{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"
/ResearchSubject/$expunge:
post:
tags:
- ResearchSubject
summary: "POST: /ResearchSubject/$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"
/ResearchSubject/{id}/$expunge:
post:
tags:
- ResearchSubject
summary: "POST: /ResearchSubject/{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"
/ResearchSubject/{id}/$diff:
get:
tags:
- ResearchSubject
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:
- ResearchSubject
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"
/RiskAssessment/{id}:
get:
tags:
- RiskAssessment
summary: "read-instance: Read RiskAssessment instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- RiskAssessment
summary: "update-instance: Update an existing RiskAssessment instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "RiskAssessment"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- RiskAssessment
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- RiskAssessment
summary: "instance-patch: Patch a resource instance of type RiskAssessment by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RiskAssessment/{id}/_history/{version_id}:
get:
tags:
- RiskAssessment
summary: "vread-instance: Read RiskAssessment instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RiskAssessment:
get:
tags:
- RiskAssessment
summary: "search-type: Search for RiskAssessment instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: performer
in: query
description: Who did assessment?
required: false
schema:
type: string
- name: method
in: query
description: Evaluation mechanism
required: false
schema:
type: string
- name: probability
in: query
description: Likelihood of specified outcome
required: false
schema:
type: number
- name: subject
in: query
description: Who/what does assessment apply to?
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* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
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: condition
in: query
description: Condition assessed
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: risk
in: query
description: Likelihood of specified outcome as a qualitative value
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
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:
- RiskAssessment
summary: "create-type: Create a new RiskAssessment instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "RiskAssessment"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RiskAssessment/_history:
get:
tags:
- RiskAssessment
summary: "type-history: Fetch the resource change history for all resources\
\ of type RiskAssessment"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RiskAssessment/{id}/_history:
get:
tags:
- RiskAssessment
summary: "instance-history: Fetch the resource change history for all resources\
\ of type RiskAssessment"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RiskAssessment/_search:
get:
tags:
- RiskAssessment
summary: "search-type: Search for RiskAssessment instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: performer
in: query
description: Who did assessment?
required: false
schema:
type: string
- name: method
in: query
description: Evaluation mechanism
required: false
schema:
type: string
- name: probability
in: query
description: Likelihood of specified outcome
required: false
schema:
type: number
- name: subject
in: query
description: Who/what does assessment apply to?
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* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
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: condition
in: query
description: Condition assessed
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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: risk
in: query
description: Likelihood of specified outcome as a qualitative value
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
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"
/RiskAssessment/$validate:
get:
tags:
- RiskAssessment
summary: "GET: /RiskAssessment/$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:
- RiskAssessment
summary: "POST: /RiskAssessment/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "RiskAssessment",
"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"
/RiskAssessment/{id}/$validate:
get:
tags:
- RiskAssessment
summary: "GET: /RiskAssessment/{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:
- RiskAssessment
summary: "POST: /RiskAssessment/{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": "RiskAssessment",
"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"
/RiskAssessment/{id}/$meta-delete:
post:
tags:
- RiskAssessment
summary: "POST: /RiskAssessment/{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"
/RiskAssessment/{id}/$meta-add:
post:
tags:
- RiskAssessment
summary: "POST: /RiskAssessment/{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"
/RiskAssessment/$meta:
get:
tags:
- RiskAssessment
summary: "GET: /RiskAssessment/$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:
- RiskAssessment
summary: "POST: /RiskAssessment/$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"
/RiskAssessment/{id}/$meta:
get:
tags:
- RiskAssessment
summary: "GET: /RiskAssessment/{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:
- RiskAssessment
summary: "POST: /RiskAssessment/{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"
/RiskAssessment/$expunge:
post:
tags:
- RiskAssessment
summary: "POST: /RiskAssessment/$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"
/RiskAssessment/{id}/$expunge:
post:
tags:
- RiskAssessment
summary: "POST: /RiskAssessment/{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"
/RiskAssessment/{id}/$diff:
get:
tags:
- RiskAssessment
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:
- RiskAssessment
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"
/RiskEvidenceSynthesis/{id}:
get:
tags:
- RiskEvidenceSynthesis
summary: "read-instance: Read RiskEvidenceSynthesis instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- RiskEvidenceSynthesis
summary: "update-instance: Update an existing RiskEvidenceSynthesis 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": "RiskEvidenceSynthesis"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- RiskEvidenceSynthesis
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:
- RiskEvidenceSynthesis
summary: "instance-patch: Patch a resource instance of type RiskEvidenceSynthesis\
\ 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"
/RiskEvidenceSynthesis/{id}/_history/{version_id}:
get:
tags:
- RiskEvidenceSynthesis
summary: "vread-instance: Read RiskEvidenceSynthesis instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RiskEvidenceSynthesis:
get:
tags:
- RiskEvidenceSynthesis
summary: "search-type: Search for RiskEvidenceSynthesis instances"
description: This is a search type
parameters:
- name: date
in: query
description: The risk evidence synthesis publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: A use context type and value assigned to the risk evidence synthesis
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the risk evidence synthesis
required: false
schema:
type: string
- name: description
in: query
description: The description of the risk evidence synthesis
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the risk evidence synthesis
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the risk evidence synthesis
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: A quantity- or range-valued use context assigned to the risk
evidence synthesis
required: false
schema:
anyOf:
- type: string
- type: number
- name: effective
in: query
description: The time during which the risk evidence synthesis is intended
to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the risk evidence synthesis
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the risk evidence synthesis
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the risk evidence synthesis
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: The business version of the risk evidence synthesis
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the risk evidence synthesis
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: Computationally friendly name of the risk evidence synthesis
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the risk evidence synthesis
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 risk evidence synthesis
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:
- RiskEvidenceSynthesis
summary: "create-type: Create a new RiskEvidenceSynthesis instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "RiskEvidenceSynthesis"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RiskEvidenceSynthesis/_history:
get:
tags:
- RiskEvidenceSynthesis
summary: "type-history: Fetch the resource change history for all resources\
\ of type RiskEvidenceSynthesis"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RiskEvidenceSynthesis/{id}/_history:
get:
tags:
- RiskEvidenceSynthesis
summary: "instance-history: Fetch the resource change history for all resources\
\ of type RiskEvidenceSynthesis"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/RiskEvidenceSynthesis/_search:
get:
tags:
- RiskEvidenceSynthesis
summary: "search-type: Search for RiskEvidenceSynthesis instances"
description: This is a search type
parameters:
- name: date
in: query
description: The risk evidence synthesis publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: A use context type and value assigned to the risk evidence synthesis
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the risk evidence synthesis
required: false
schema:
type: string
- name: description
in: query
description: The description of the risk evidence synthesis
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the risk evidence synthesis
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the risk evidence synthesis
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: A quantity- or range-valued use context assigned to the risk
evidence synthesis
required: false
schema:
anyOf:
- type: string
- type: number
- name: effective
in: query
description: The time during which the risk evidence synthesis is intended
to be in use
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context
in: query
description: A use context assigned to the risk evidence synthesis
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the risk evidence synthesis
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the risk evidence synthesis
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: The business version of the risk evidence synthesis
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the risk evidence synthesis
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: Computationally friendly name of the risk evidence synthesis
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the risk evidence synthesis
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 risk evidence synthesis
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"
/RiskEvidenceSynthesis/$validate:
get:
tags:
- RiskEvidenceSynthesis
summary: "GET: /RiskEvidenceSynthesis/$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:
- RiskEvidenceSynthesis
summary: "POST: /RiskEvidenceSynthesis/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "RiskEvidenceSynthesis",
"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"
/RiskEvidenceSynthesis/{id}/$validate:
get:
tags:
- RiskEvidenceSynthesis
summary: "GET: /RiskEvidenceSynthesis/{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:
- RiskEvidenceSynthesis
summary: "POST: /RiskEvidenceSynthesis/{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": "RiskEvidenceSynthesis",
"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"
/RiskEvidenceSynthesis/{id}/$meta-delete:
post:
tags:
- RiskEvidenceSynthesis
summary: "POST: /RiskEvidenceSynthesis/{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"
/RiskEvidenceSynthesis/{id}/$meta-add:
post:
tags:
- RiskEvidenceSynthesis
summary: "POST: /RiskEvidenceSynthesis/{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"
/RiskEvidenceSynthesis/$meta:
get:
tags:
- RiskEvidenceSynthesis
summary: "GET: /RiskEvidenceSynthesis/$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:
- RiskEvidenceSynthesis
summary: "POST: /RiskEvidenceSynthesis/$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"
/RiskEvidenceSynthesis/{id}/$meta:
get:
tags:
- RiskEvidenceSynthesis
summary: "GET: /RiskEvidenceSynthesis/{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:
- RiskEvidenceSynthesis
summary: "POST: /RiskEvidenceSynthesis/{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"
/RiskEvidenceSynthesis/$expunge:
post:
tags:
- RiskEvidenceSynthesis
summary: "POST: /RiskEvidenceSynthesis/$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"
/RiskEvidenceSynthesis/{id}/$expunge:
post:
tags:
- RiskEvidenceSynthesis
summary: "POST: /RiskEvidenceSynthesis/{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"
/RiskEvidenceSynthesis/{id}/$diff:
get:
tags:
- RiskEvidenceSynthesis
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:
- RiskEvidenceSynthesis
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"
/Schedule/{id}:
get:
tags:
- Schedule
summary: "read-instance: Read Schedule instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Schedule
summary: "update-instance: Update an existing Schedule instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Schedule"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Schedule
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Schedule
summary: "instance-patch: Patch a resource instance of type Schedule by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Schedule/{id}/_history/{version_id}:
get:
tags:
- Schedule
summary: "vread-instance: Read Schedule instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Schedule:
get:
tags:
- Schedule
summary: "search-type: Search for Schedule instances"
description: This is a search type
parameters:
- name: date
in: query
description: Search for Schedule resources that have a period that contains
this date specified
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: A Schedule Identifier
required: false
schema:
type: string
- name: specialty
in: query
description: Type of specialty needed
required: false
schema:
type: string
- name: service-category
in: query
description: High-level category
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: service-type
in: query
description: The type of appointments that can be booked into associated slot(s)
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Is the schedule in active use
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: actor
in: query
description: "The individual(HealthcareService, Practitioner, Location, ...)\
\ to find a Schedule for"
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Schedule
summary: "create-type: Create a new Schedule instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Schedule"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Schedule/_history:
get:
tags:
- Schedule
summary: "type-history: Fetch the resource change history for all resources\
\ of type Schedule"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Schedule/{id}/_history:
get:
tags:
- Schedule
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Schedule"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Schedule/_search:
get:
tags:
- Schedule
summary: "search-type: Search for Schedule instances"
description: This is a search type
parameters:
- name: date
in: query
description: Search for Schedule resources that have a period that contains
this date specified
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: A Schedule Identifier
required: false
schema:
type: string
- name: specialty
in: query
description: Type of specialty needed
required: false
schema:
type: string
- name: service-category
in: query
description: High-level category
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: service-type
in: query
description: The type of appointments that can be booked into associated slot(s)
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: active
in: query
description: Is the schedule in active use
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: actor
in: query
description: "The individual(HealthcareService, Practitioner, Location, ...)\
\ to find a Schedule for"
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Schedule/$validate:
get:
tags:
- Schedule
summary: "GET: /Schedule/$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:
- Schedule
summary: "POST: /Schedule/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Schedule",
"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"
/Schedule/{id}/$validate:
get:
tags:
- Schedule
summary: "GET: /Schedule/{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:
- Schedule
summary: "POST: /Schedule/{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": "Schedule",
"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"
/Schedule/{id}/$meta-delete:
post:
tags:
- Schedule
summary: "POST: /Schedule/{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"
/Schedule/{id}/$meta-add:
post:
tags:
- Schedule
summary: "POST: /Schedule/{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"
/Schedule/$meta:
get:
tags:
- Schedule
summary: "GET: /Schedule/$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:
- Schedule
summary: "POST: /Schedule/$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"
/Schedule/{id}/$meta:
get:
tags:
- Schedule
summary: "GET: /Schedule/{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:
- Schedule
summary: "POST: /Schedule/{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"
/Schedule/$expunge:
post:
tags:
- Schedule
summary: "POST: /Schedule/$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"
/Schedule/{id}/$expunge:
post:
tags:
- Schedule
summary: "POST: /Schedule/{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"
/Schedule/{id}/$diff:
get:
tags:
- Schedule
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:
- Schedule
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/{id}:
get:
tags:
- SearchParameter
summary: "read-instance: Read SearchParameter instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- SearchParameter
summary: "update-instance: Update an existing SearchParameter instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SearchParameter"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- SearchParameter
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- SearchParameter
summary: "instance-patch: Patch a resource instance of type SearchParameter\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/{id}/_history/{version_id}:
get:
tags:
- SearchParameter
summary: "vread-instance: Read SearchParameter instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter:
get:
tags:
- SearchParameter
summary: "search-type: Search for SearchParameter instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: Code used in URL
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: derived-from
in: query
description: Original definition for the search parameter
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: type
in: query
description: number | date | string | token | reference | composite | quantity
| uri | special
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: target
in: query
description: Types of resource (if a resource reference)
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: component
in: query
description: Defines how the part works
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
- name: base
in: query
description: The resource type(s) this search parameter applies to
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- SearchParameter
summary: "create-type: Create a new SearchParameter instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SearchParameter"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/_history:
get:
tags:
- SearchParameter
summary: "type-history: Fetch the resource change history for all resources\
\ of type SearchParameter"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/{id}/_history:
get:
tags:
- SearchParameter
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SearchParameter"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/_search:
get:
tags:
- SearchParameter
summary: "search-type: Search for SearchParameter instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: Code used in URL
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: derived-from
in: query
description: Original definition for the search parameter
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: type
in: query
description: number | date | string | token | reference | composite | quantity
| uri | special
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: target
in: query
description: Types of resource (if a resource reference)
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: component
in: query
description: Defines how the part works
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
- name: base
in: query
description: The resource type(s) this search parameter applies to
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/$validate:
get:
tags:
- SearchParameter
summary: "GET: /SearchParameter/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "SearchParameter",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/{id}/$validate:
get:
tags:
- SearchParameter
summary: "GET: /SearchParameter/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "SearchParameter",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/{id}/$meta-delete:
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/{id}/$meta-add:
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/$meta:
get:
tags:
- SearchParameter
summary: "GET: /SearchParameter/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/{id}/$meta:
get:
tags:
- SearchParameter
summary: "GET: /SearchParameter/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/$expunge:
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/{id}/$expunge:
post:
tags:
- SearchParameter
summary: "POST: /SearchParameter/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SearchParameter/{id}/$diff:
get:
tags:
- SearchParameter
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- SearchParameter
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ServiceRequest/{id}:
get:
tags:
- ServiceRequest
summary: "read-instance: Read ServiceRequest instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ServiceRequest
summary: "update-instance: Update an existing ServiceRequest instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ServiceRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- ServiceRequest
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- ServiceRequest
summary: "instance-patch: Patch a resource instance of type ServiceRequest by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ServiceRequest/{id}/_history/{version_id}:
get:
tags:
- ServiceRequest
summary: "vread-instance: Read ServiceRequest instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ServiceRequest:
get:
tags:
- ServiceRequest
summary: "search-type: Search for ServiceRequest instances"
description: This is a search type
parameters:
- name: authored
in: query
description: Date request signed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: requisition
in: query
description: Composite Request ID
required: false
schema:
type: string
- name: subject
in: query
description: Search by subject
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: occurrence
in: query
description: When service should occur
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: What request fulfills
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: specimen
in: query
description: Specimen to be tested
required: false
schema:
type: string
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
required: false
schema:
type: string
- name: requester
in: query
description: Who/what is requesting service
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: performer
in: query
description: Requested performer
required: false
schema:
type: string
- name: replaces
in: query
description: What request replaces
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: priority
in: query
description: routine | urgent | asap | stat
required: false
schema:
type: string
- name: intent
in: query
description: proposal | plan | directive | order | original-order | reflex-order
| filler-order | instance-order | option
required: false
schema:
type: string
- name: performer-type
in: query
description: Performer role
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: body-site
in: query
description: Where procedure is going to be done
required: false
schema:
type: string
- name: category
in: query
description: Classification of service
required: false
schema:
type: string
- name: status
in: query
description: draft | active | on-hold | revoked | completed | entered-in-error
| unknown
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:
- ServiceRequest
summary: "create-type: Create a new ServiceRequest instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ServiceRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ServiceRequest/_history:
get:
tags:
- ServiceRequest
summary: "type-history: Fetch the resource change history for all resources\
\ of type ServiceRequest"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ServiceRequest/{id}/_history:
get:
tags:
- ServiceRequest
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ServiceRequest"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ServiceRequest/_search:
get:
tags:
- ServiceRequest
summary: "search-type: Search for ServiceRequest instances"
description: This is a search type
parameters:
- name: authored
in: query
description: Date request signed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Code that identifies the allergy or intolerance\r\n* [Condition](condition.html):\
\ Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code\
\ for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The code for the report, as opposed to codes for the atomic results, which\
\ are the names on the observation resource referred to from the result\r\
\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition\
\ code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html):\
\ Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements of this medication code\r\n* [Observation](observation.html):\
\ The code of the observation type\r\n* [Procedure](procedure.html): A code\
\ to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What\
\ is being requested/ordered"
required: false
schema:
type: string
- name: requisition
in: query
description: Composite Request ID
required: false
schema:
type: string
- name: subject
in: query
description: Search by subject
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: occurrence
in: query
description: When service should occur
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: What request fulfills
required: false
schema:
type: string
- name: patient
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: specimen
in: query
description: Specimen to be tested
required: false
schema:
type: string
- name: instantiates-uri
in: query
description: Instantiates external protocol or definition
required: false
schema:
type: string
- name: requester
in: query
description: Who/what is requesting service
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: performer
in: query
description: Requested performer
required: false
schema:
type: string
- name: replaces
in: query
description: What request replaces
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: instantiates-canonical
in: query
description: Instantiates FHIR protocol or definition
required: false
schema:
type: string
- name: encounter
in: query
description: "Multiple Resources: \r\n\r\n* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
required: false
schema:
type: string
- name: priority
in: query
description: routine | urgent | asap | stat
required: false
schema:
type: string
- name: intent
in: query
description: proposal | plan | directive | order | original-order | reflex-order
| filler-order | instance-order | option
required: false
schema:
type: string
- name: performer-type
in: query
description: Performer role
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: body-site
in: query
description: Where procedure is going to be done
required: false
schema:
type: string
- name: category
in: query
description: Classification of service
required: false
schema:
type: string
- name: status
in: query
description: draft | active | on-hold | revoked | completed | entered-in-error
| unknown
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"
/ServiceRequest/$validate:
get:
tags:
- ServiceRequest
summary: "GET: /ServiceRequest/$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:
- ServiceRequest
summary: "POST: /ServiceRequest/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ServiceRequest",
"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"
/ServiceRequest/{id}/$validate:
get:
tags:
- ServiceRequest
summary: "GET: /ServiceRequest/{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:
- ServiceRequest
summary: "POST: /ServiceRequest/{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": "ServiceRequest",
"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"
/ServiceRequest/{id}/$meta-delete:
post:
tags:
- ServiceRequest
summary: "POST: /ServiceRequest/{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"
/ServiceRequest/{id}/$meta-add:
post:
tags:
- ServiceRequest
summary: "POST: /ServiceRequest/{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"
/ServiceRequest/$meta:
get:
tags:
- ServiceRequest
summary: "GET: /ServiceRequest/$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:
- ServiceRequest
summary: "POST: /ServiceRequest/$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"
/ServiceRequest/{id}/$meta:
get:
tags:
- ServiceRequest
summary: "GET: /ServiceRequest/{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:
- ServiceRequest
summary: "POST: /ServiceRequest/{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"
/ServiceRequest/$expunge:
post:
tags:
- ServiceRequest
summary: "POST: /ServiceRequest/$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"
/ServiceRequest/{id}/$expunge:
post:
tags:
- ServiceRequest
summary: "POST: /ServiceRequest/{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"
/ServiceRequest/{id}/$diff:
get:
tags:
- ServiceRequest
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:
- ServiceRequest
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"
/Slot/{id}:
get:
tags:
- Slot
summary: "read-instance: Read Slot instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Slot
summary: "update-instance: Update an existing Slot instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Slot"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Slot
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Slot
summary: "instance-patch: Patch a resource instance of type Slot by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Slot/{id}/_history/{version_id}:
get:
tags:
- Slot
summary: "vread-instance: Read Slot instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Slot:
get:
tags:
- Slot
summary: "search-type: Search for Slot instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: A Slot Identifier
required: false
schema:
type: string
- name: specialty
in: query
description: The specialty of a practitioner that would be required to perform
the service requested in this appointment
required: false
schema:
type: string
- name: service-category
in: query
description: A broad categorization of the service that is to be performed
during this appointment
required: false
schema:
type: string
- name: appointment-type
in: query
description: The style of appointment or patient that may be booked in the
slot (not service type)
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: service-type
in: query
description: The type of appointments that can be booked into the slot
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: start
in: query
description: Appointment date/time.
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: schedule
in: query
description: The Schedule Resource that we are seeking a slot within
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 free/busy status of the appointment
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:
- Slot
summary: "create-type: Create a new Slot instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Slot"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Slot/_history:
get:
tags:
- Slot
summary: "type-history: Fetch the resource change history for all resources\
\ of type Slot"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Slot/{id}/_history:
get:
tags:
- Slot
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Slot"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Slot/_search:
get:
tags:
- Slot
summary: "search-type: Search for Slot instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: A Slot Identifier
required: false
schema:
type: string
- name: specialty
in: query
description: The specialty of a practitioner that would be required to perform
the service requested in this appointment
required: false
schema:
type: string
- name: service-category
in: query
description: A broad categorization of the service that is to be performed
during this appointment
required: false
schema:
type: string
- name: appointment-type
in: query
description: The style of appointment or patient that may be booked in the
slot (not service type)
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: service-type
in: query
description: The type of appointments that can be booked into the slot
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: start
in: query
description: Appointment date/time.
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: schedule
in: query
description: The Schedule Resource that we are seeking a slot within
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 free/busy status of the appointment
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"
/Slot/$validate:
get:
tags:
- Slot
summary: "GET: /Slot/$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:
- Slot
summary: "POST: /Slot/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Slot",
"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"
/Slot/{id}/$validate:
get:
tags:
- Slot
summary: "GET: /Slot/{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:
- Slot
summary: "POST: /Slot/{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": "Slot",
"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"
/Slot/{id}/$meta-delete:
post:
tags:
- Slot
summary: "POST: /Slot/{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"
/Slot/{id}/$meta-add:
post:
tags:
- Slot
summary: "POST: /Slot/{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"
/Slot/$meta:
get:
tags:
- Slot
summary: "GET: /Slot/$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:
- Slot
summary: "POST: /Slot/$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"
/Slot/{id}/$meta:
get:
tags:
- Slot
summary: "GET: /Slot/{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:
- Slot
summary: "POST: /Slot/{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"
/Slot/$expunge:
post:
tags:
- Slot
summary: "POST: /Slot/$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"
/Slot/{id}/$expunge:
post:
tags:
- Slot
summary: "POST: /Slot/{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"
/Slot/{id}/$diff:
get:
tags:
- Slot
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:
- Slot
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"
/Specimen/{id}:
get:
tags:
- Specimen
summary: "read-instance: Read Specimen instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Specimen
summary: "update-instance: Update an existing Specimen instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Specimen"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Specimen
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Specimen
summary: "instance-patch: Patch a resource instance of type Specimen by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Specimen/{id}/_history/{version_id}:
get:
tags:
- Specimen
summary: "vread-instance: Read Specimen instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Specimen:
get:
tags:
- Specimen
summary: "search-type: Search for Specimen instances"
description: This is a search type
parameters:
- name: container
in: query
description: The kind of specimen container
required: false
schema:
type: string
- name: container-id
in: query
description: The unique identifier associated with the specimen container
required: false
schema:
type: string
- name: identifier
in: query
description: The unique identifier associated with the specimen
required: false
schema:
type: string
- name: parent
in: query
description: The parent of the specimen
required: false
schema:
type: string
- name: bodysite
in: query
description: The code for the body site from where the specimen originated
required: false
schema:
type: string
- name: subject
in: query
description: The subject of the specimen
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: collected
in: query
description: The date the specimen was collected
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: accession
in: query
description: The accession number associated with the specimen
required: false
schema:
type: string
- name: type
in: query
description: The specimen type
required: false
schema:
type: string
- name: collector
in: query
description: Who collected the specimen
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 the specimen comes from
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: available | unavailable | unsatisfactory | entered-in-error
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:
- Specimen
summary: "create-type: Create a new Specimen instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Specimen"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Specimen/_history:
get:
tags:
- Specimen
summary: "type-history: Fetch the resource change history for all resources\
\ of type Specimen"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Specimen/{id}/_history:
get:
tags:
- Specimen
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Specimen"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Specimen/_search:
get:
tags:
- Specimen
summary: "search-type: Search for Specimen instances"
description: This is a search type
parameters:
- name: container
in: query
description: The kind of specimen container
required: false
schema:
type: string
- name: container-id
in: query
description: The unique identifier associated with the specimen container
required: false
schema:
type: string
- name: identifier
in: query
description: The unique identifier associated with the specimen
required: false
schema:
type: string
- name: parent
in: query
description: The parent of the specimen
required: false
schema:
type: string
- name: bodysite
in: query
description: The code for the body site from where the specimen originated
required: false
schema:
type: string
- name: subject
in: query
description: The subject of the specimen
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: collected
in: query
description: The date the specimen was collected
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: accession
in: query
description: The accession number associated with the specimen
required: false
schema:
type: string
- name: type
in: query
description: The specimen type
required: false
schema:
type: string
- name: collector
in: query
description: Who collected the specimen
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 the specimen comes from
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: available | unavailable | unsatisfactory | entered-in-error
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"
/Specimen/$validate:
get:
tags:
- Specimen
summary: "GET: /Specimen/$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:
- Specimen
summary: "POST: /Specimen/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Specimen",
"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"
/Specimen/{id}/$validate:
get:
tags:
- Specimen
summary: "GET: /Specimen/{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:
- Specimen
summary: "POST: /Specimen/{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": "Specimen",
"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"
/Specimen/{id}/$meta-delete:
post:
tags:
- Specimen
summary: "POST: /Specimen/{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"
/Specimen/{id}/$meta-add:
post:
tags:
- Specimen
summary: "POST: /Specimen/{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"
/Specimen/$meta:
get:
tags:
- Specimen
summary: "GET: /Specimen/$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:
- Specimen
summary: "POST: /Specimen/$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"
/Specimen/{id}/$meta:
get:
tags:
- Specimen
summary: "GET: /Specimen/{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:
- Specimen
summary: "POST: /Specimen/{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"
/Specimen/$expunge:
post:
tags:
- Specimen
summary: "POST: /Specimen/$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"
/Specimen/{id}/$expunge:
post:
tags:
- Specimen
summary: "POST: /Specimen/{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"
/Specimen/{id}/$diff:
get:
tags:
- Specimen
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:
- Specimen
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"
/SpecimenDefinition/{id}:
get:
tags:
- SpecimenDefinition
summary: "read-instance: Read SpecimenDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- SpecimenDefinition
summary: "update-instance: Update an existing SpecimenDefinition instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SpecimenDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- SpecimenDefinition
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- SpecimenDefinition
summary: "instance-patch: Patch a resource instance of type SpecimenDefinition\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SpecimenDefinition/{id}/_history/{version_id}:
get:
tags:
- SpecimenDefinition
summary: "vread-instance: Read SpecimenDefinition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SpecimenDefinition:
get:
tags:
- SpecimenDefinition
summary: "search-type: Search for SpecimenDefinition instances"
description: This is a search type
parameters:
- name: container
in: query
description: The type of specimen conditioned in container expected by the
lab
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: identifier
in: query
description: The unique identifier associated with the specimen
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
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: _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: _security
in: query
description: Security Labels applied to this resource
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: type
in: query
description: The type of collected specimen
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- SpecimenDefinition
summary: "create-type: Create a new SpecimenDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SpecimenDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SpecimenDefinition/_history:
get:
tags:
- SpecimenDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type SpecimenDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SpecimenDefinition/{id}/_history:
get:
tags:
- SpecimenDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SpecimenDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SpecimenDefinition/_search:
get:
tags:
- SpecimenDefinition
summary: "search-type: Search for SpecimenDefinition instances"
description: This is a search type
parameters:
- name: container
in: query
description: The type of specimen conditioned in container expected by the
lab
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: identifier
in: query
description: The unique identifier associated with the specimen
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
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: _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: _security
in: query
description: Security Labels applied to this resource
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: type
in: query
description: The type of collected specimen
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SpecimenDefinition/$validate:
get:
tags:
- SpecimenDefinition
summary: "GET: /SpecimenDefinition/$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:
- SpecimenDefinition
summary: "POST: /SpecimenDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "SpecimenDefinition",
"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"
/SpecimenDefinition/{id}/$validate:
get:
tags:
- SpecimenDefinition
summary: "GET: /SpecimenDefinition/{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:
- SpecimenDefinition
summary: "POST: /SpecimenDefinition/{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": "SpecimenDefinition",
"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"
/SpecimenDefinition/{id}/$meta-delete:
post:
tags:
- SpecimenDefinition
summary: "POST: /SpecimenDefinition/{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"
/SpecimenDefinition/{id}/$meta-add:
post:
tags:
- SpecimenDefinition
summary: "POST: /SpecimenDefinition/{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"
/SpecimenDefinition/$meta:
get:
tags:
- SpecimenDefinition
summary: "GET: /SpecimenDefinition/$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:
- SpecimenDefinition
summary: "POST: /SpecimenDefinition/$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"
/SpecimenDefinition/{id}/$meta:
get:
tags:
- SpecimenDefinition
summary: "GET: /SpecimenDefinition/{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:
- SpecimenDefinition
summary: "POST: /SpecimenDefinition/{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"
/SpecimenDefinition/$expunge:
post:
tags:
- SpecimenDefinition
summary: "POST: /SpecimenDefinition/$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"
/SpecimenDefinition/{id}/$expunge:
post:
tags:
- SpecimenDefinition
summary: "POST: /SpecimenDefinition/{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"
/SpecimenDefinition/{id}/$diff:
get:
tags:
- SpecimenDefinition
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:
- SpecimenDefinition
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"
/StructureDefinition/{id}:
get:
tags:
- StructureDefinition
summary: "read-instance: Read StructureDefinition instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- StructureDefinition
summary: "update-instance: Update an existing StructureDefinition instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "StructureDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- StructureDefinition
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- StructureDefinition
summary: "instance-patch: Patch a resource instance of type StructureDefinition\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureDefinition/{id}/_history/{version_id}:
get:
tags:
- StructureDefinition
summary: "vread-instance: Read StructureDefinition instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureDefinition:
get:
tags:
- StructureDefinition
summary: "search-type: Search for StructureDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: experimental
in: query
description: "For testing purposes, not real usage"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: type
in: query
description: Type defined or constrained by this structure
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: path
in: query
description: A path that is constrained in the StructureDefinition
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: base-path
in: query
description: Path that identifies the base element
required: false
schema:
type: string
- name: keyword
in: query
description: A code for the StructureDefinition
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\
\ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\
\ External identifier for the structure map\r\n* [ValueSet](valueset.html):\
\ External identifier for the value set"
required: false
schema:
type: string
- name: valueset
in: query
description: A vocabulary binding reference
required: false
schema:
type: string
- name: kind
in: query
description: primitive-type | complex-type | resource | logical
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: abstract
in: query
description: Whether the structure is abstract
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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: ext-context
in: query
description: "The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: derivation
in: query
description: specialization | constraint - How relates to base definition
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
- name: base
in: query
description: Definition that this type is constrained/specialized from
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:
- StructureDefinition
summary: "create-type: Create a new StructureDefinition instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "StructureDefinition"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureDefinition/_history:
get:
tags:
- StructureDefinition
summary: "type-history: Fetch the resource change history for all resources\
\ of type StructureDefinition"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureDefinition/{id}/_history:
get:
tags:
- StructureDefinition
summary: "instance-history: Fetch the resource change history for all resources\
\ of type StructureDefinition"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureDefinition/_search:
get:
tags:
- StructureDefinition
summary: "search-type: Search for StructureDefinition instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: experimental
in: query
description: "For testing purposes, not real usage"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: type
in: query
description: Type defined or constrained by this structure
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: path
in: query
description: A path that is constrained in the StructureDefinition
required: false
schema:
type: string
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: base-path
in: query
description: Path that identifies the base element
required: false
schema:
type: string
- name: keyword
in: query
description: A code for the StructureDefinition
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\
\ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\
\ External identifier for the structure map\r\n* [ValueSet](valueset.html):\
\ External identifier for the value set"
required: false
schema:
type: string
- name: valueset
in: query
description: A vocabulary binding reference
required: false
schema:
type: string
- name: kind
in: query
description: primitive-type | complex-type | resource | logical
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: abstract
in: query
description: Whether the structure is abstract
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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: ext-context
in: query
description: "The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: derivation
in: query
description: specialization | constraint - How relates to base definition
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
- name: base
in: query
description: Definition that this type is constrained/specialized from
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"
/StructureDefinition/$validate:
get:
tags:
- StructureDefinition
summary: "GET: /StructureDefinition/$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:
- StructureDefinition
summary: "POST: /StructureDefinition/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "StructureDefinition",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureDefinition/{id}/$validate:
get:
tags:
- StructureDefinition
summary: "GET: /StructureDefinition/{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:
- StructureDefinition
summary: "POST: /StructureDefinition/{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": "StructureDefinition",
"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"
/StructureDefinition/{id}/$meta-delete:
post:
tags:
- StructureDefinition
summary: "POST: /StructureDefinition/{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"
/StructureDefinition/{id}/$meta-add:
post:
tags:
- StructureDefinition
summary: "POST: /StructureDefinition/{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"
/StructureDefinition/$meta:
get:
tags:
- StructureDefinition
summary: "GET: /StructureDefinition/$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:
- StructureDefinition
summary: "POST: /StructureDefinition/$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"
/StructureDefinition/{id}/$meta:
get:
tags:
- StructureDefinition
summary: "GET: /StructureDefinition/{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:
- StructureDefinition
summary: "POST: /StructureDefinition/{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"
/StructureDefinition/$expunge:
post:
tags:
- StructureDefinition
summary: "POST: /StructureDefinition/$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"
/StructureDefinition/{id}/$expunge:
post:
tags:
- StructureDefinition
summary: "POST: /StructureDefinition/{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"
/StructureDefinition/$snapshot:
get:
tags:
- StructureDefinition
summary: "GET: /StructureDefinition/$snapshot"
parameters:
- name: url
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:
- StructureDefinition
summary: "POST: /StructureDefinition/$snapshot"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "definition"
}, {
"name": "url",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureDefinition/{id}/$snapshot:
get:
tags:
- StructureDefinition
summary: "GET: /StructureDefinition/{id}/$snapshot"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: url
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- StructureDefinition
summary: "POST: /StructureDefinition/{id}/$snapshot"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "definition"
}, {
"name": "url",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureDefinition/{id}/$diff:
get:
tags:
- StructureDefinition
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:
- StructureDefinition
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"
/StructureMap/{id}:
get:
tags:
- StructureMap
summary: "read-instance: Read StructureMap instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- StructureMap
summary: "update-instance: Update an existing StructureMap instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "StructureMap"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- StructureMap
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- StructureMap
summary: "instance-patch: Patch a resource instance of type StructureMap by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureMap/{id}/_history/{version_id}:
get:
tags:
- StructureMap
summary: "vread-instance: Read StructureMap instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureMap:
get:
tags:
- StructureMap
summary: "search-type: Search for StructureMap instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\
\ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\
\ External identifier for the structure map\r\n* [ValueSet](valueset.html):\
\ External identifier for the value set"
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- StructureMap
summary: "create-type: Create a new StructureMap instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "StructureMap"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureMap/_history:
get:
tags:
- StructureMap
summary: "type-history: Fetch the resource change history for all resources\
\ of type StructureMap"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureMap/{id}/_history:
get:
tags:
- StructureMap
summary: "instance-history: Fetch the resource change history for all resources\
\ of type StructureMap"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureMap/_search:
get:
tags:
- StructureMap
summary: "search-type: Search for StructureMap instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\
\ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\
\ External identifier for the structure map\r\n* [ValueSet](valueset.html):\
\ External identifier for the value set"
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/StructureMap/$validate:
get:
tags:
- StructureMap
summary: "GET: /StructureMap/$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:
- StructureMap
summary: "POST: /StructureMap/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "StructureMap",
"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"
/StructureMap/{id}/$validate:
get:
tags:
- StructureMap
summary: "GET: /StructureMap/{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:
- StructureMap
summary: "POST: /StructureMap/{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": "StructureMap",
"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"
/StructureMap/{id}/$meta-delete:
post:
tags:
- StructureMap
summary: "POST: /StructureMap/{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"
/StructureMap/{id}/$meta-add:
post:
tags:
- StructureMap
summary: "POST: /StructureMap/{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"
/StructureMap/$meta:
get:
tags:
- StructureMap
summary: "GET: /StructureMap/$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:
- StructureMap
summary: "POST: /StructureMap/$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"
/StructureMap/{id}/$meta:
get:
tags:
- StructureMap
summary: "GET: /StructureMap/{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:
- StructureMap
summary: "POST: /StructureMap/{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"
/StructureMap/$expunge:
post:
tags:
- StructureMap
summary: "POST: /StructureMap/$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"
/StructureMap/{id}/$expunge:
post:
tags:
- StructureMap
summary: "POST: /StructureMap/{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"
/StructureMap/{id}/$diff:
get:
tags:
- StructureMap
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:
- StructureMap
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/{id}:
get:
tags:
- Subscription
summary: "read-instance: Read Subscription instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Subscription
summary: "update-instance: Update an existing Subscription instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Subscription"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Subscription
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Subscription
summary: "instance-patch: Patch a resource instance of type Subscription by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/{id}/_history/{version_id}:
get:
tags:
- Subscription
summary: "vread-instance: Read Subscription instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription:
get:
tags:
- Subscription
summary: "search-type: Search for Subscription instances"
description: This is a search type
parameters:
- name: criteria
in: query
description: The search rules used to determine when to send a notification
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: The type of channel for the sent notifications
required: false
schema:
type: string
- name: url
in: query
description: The uri that will receive the notifications
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: payload
in: query
description: The mime-type of the notification payload
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: contact
in: query
description: Contact details for the subscription
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: The current state of the subscription
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Subscription
summary: "create-type: Create a new Subscription instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Subscription"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/_history:
get:
tags:
- Subscription
summary: "type-history: Fetch the resource change history for all resources\
\ of type Subscription"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/{id}/_history:
get:
tags:
- Subscription
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Subscription"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/_search:
get:
tags:
- Subscription
summary: "search-type: Search for Subscription instances"
description: This is a search type
parameters:
- name: criteria
in: query
description: The search rules used to determine when to send a notification
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: type
in: query
description: The type of channel for the sent notifications
required: false
schema:
type: string
- name: url
in: query
description: The uri that will receive the notifications
required: false
schema:
type: string
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
required: false
schema:
type: string
- name: payload
in: query
description: The mime-type of the notification payload
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: contact
in: query
description: Contact details for the subscription
required: false
schema:
type: string
- name: _has
in: query
description: Return resources linked to by the given target
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: The current state of the subscription
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/$trigger-subscription:
post:
tags:
- Subscription
summary: "POST: /Subscription/$trigger-subscription"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resourceId",
"valueUri": "example"
}, {
"name": "searchUrl",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/{id}/$trigger-subscription:
post:
tags:
- Subscription
summary: "POST: /Subscription/{id}/$trigger-subscription"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resourceId",
"valueUri": "example"
}, {
"name": "searchUrl",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/$validate:
get:
tags:
- Subscription
summary: "GET: /Subscription/$validate"
parameters:
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Subscription
summary: "POST: /Subscription/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Subscription",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/{id}/$validate:
get:
tags:
- Subscription
summary: "GET: /Subscription/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: mode
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Subscription
summary: "POST: /Subscription/{id}/$validate"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Subscription",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/{id}/$meta-delete:
post:
tags:
- Subscription
summary: "POST: /Subscription/{id}/$meta-delete"
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/{id}/$meta-add:
post:
tags:
- Subscription
summary: "POST: /Subscription/{id}/$meta-add"
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/$meta:
get:
tags:
- Subscription
summary: "GET: /Subscription/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Subscription
summary: "POST: /Subscription/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/{id}/$meta:
get:
tags:
- Subscription
summary: "GET: /Subscription/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Subscription
summary: "POST: /Subscription/{id}/$meta"
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/$expunge:
post:
tags:
- Subscription
summary: "POST: /Subscription/$expunge"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/{id}/$expunge:
post:
tags:
- Subscription
summary: "POST: /Subscription/{id}/$expunge"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Subscription/{id}/$diff:
get:
tags:
- Subscription
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Subscription
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Substance/{id}:
get:
tags:
- Substance
summary: "read-instance: Read Substance instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Substance
summary: "update-instance: Update an existing Substance instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Substance"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Substance
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Substance
summary: "instance-patch: Patch a resource instance of type Substance by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Substance/{id}/_history/{version_id}:
get:
tags:
- Substance
summary: "vread-instance: Read Substance instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Substance:
get:
tags:
- Substance
summary: "search-type: Search for Substance instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Unique identifier for the substance
required: false
schema:
type: string
- name: container-identifier
in: query
description: Identifier of the package/container
required: false
schema:
type: string
- name: code
in: query
description: The code of the substance or ingredient
required: false
schema:
type: string
- name: quantity
in: query
description: Amount of substance in the package
required: false
schema:
anyOf:
- type: string
- type: number
- 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: substance-reference
in: query
description: A component of the substance
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: expiry
in: query
description: Expiry date of package or container of substance
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: category
in: query
description: The category of the substance
required: false
schema:
type: string
- name: status
in: query
description: active | inactive | entered-in-error
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:
- Substance
summary: "create-type: Create a new Substance instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Substance"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Substance/_history:
get:
tags:
- Substance
summary: "type-history: Fetch the resource change history for all resources\
\ of type Substance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Substance/{id}/_history:
get:
tags:
- Substance
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Substance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Substance/_search:
get:
tags:
- Substance
summary: "search-type: Search for Substance instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: Unique identifier for the substance
required: false
schema:
type: string
- name: container-identifier
in: query
description: Identifier of the package/container
required: false
schema:
type: string
- name: code
in: query
description: The code of the substance or ingredient
required: false
schema:
type: string
- name: quantity
in: query
description: Amount of substance in the package
required: false
schema:
anyOf:
- type: string
- type: number
- 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: substance-reference
in: query
description: A component of the substance
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: expiry
in: query
description: Expiry date of package or container of substance
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: category
in: query
description: The category of the substance
required: false
schema:
type: string
- name: status
in: query
description: active | inactive | entered-in-error
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"
/Substance/$validate:
get:
tags:
- Substance
summary: "GET: /Substance/$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:
- Substance
summary: "POST: /Substance/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Substance",
"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"
/Substance/{id}/$validate:
get:
tags:
- Substance
summary: "GET: /Substance/{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:
- Substance
summary: "POST: /Substance/{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": "Substance",
"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"
/Substance/{id}/$meta-delete:
post:
tags:
- Substance
summary: "POST: /Substance/{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"
/Substance/{id}/$meta-add:
post:
tags:
- Substance
summary: "POST: /Substance/{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"
/Substance/$meta:
get:
tags:
- Substance
summary: "GET: /Substance/$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:
- Substance
summary: "POST: /Substance/$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"
/Substance/{id}/$meta:
get:
tags:
- Substance
summary: "GET: /Substance/{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:
- Substance
summary: "POST: /Substance/{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"
/Substance/$expunge:
post:
tags:
- Substance
summary: "POST: /Substance/$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"
/Substance/{id}/$expunge:
post:
tags:
- Substance
summary: "POST: /Substance/{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"
/Substance/{id}/$diff:
get:
tags:
- Substance
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:
- Substance
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"
/SubstanceNucleicAcid/{id}:
get:
tags:
- SubstanceNucleicAcid
summary: "read-instance: Read SubstanceNucleicAcid instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- SubstanceNucleicAcid
summary: "update-instance: Update an existing SubstanceNucleicAcid instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SubstanceNucleicAcid"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- SubstanceNucleicAcid
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- SubstanceNucleicAcid
summary: "instance-patch: Patch a resource instance of type SubstanceNucleicAcid\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceNucleicAcid/{id}/_history/{version_id}:
get:
tags:
- SubstanceNucleicAcid
summary: "vread-instance: Read SubstanceNucleicAcid instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceNucleicAcid:
get:
tags:
- SubstanceNucleicAcid
summary: "search-type: Search for SubstanceNucleicAcid instances"
description: This is a search type
parameters:
- name: _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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- SubstanceNucleicAcid
summary: "create-type: Create a new SubstanceNucleicAcid instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SubstanceNucleicAcid"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceNucleicAcid/_history:
get:
tags:
- SubstanceNucleicAcid
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubstanceNucleicAcid"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceNucleicAcid/{id}/_history:
get:
tags:
- SubstanceNucleicAcid
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubstanceNucleicAcid"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceNucleicAcid/_search:
get:
tags:
- SubstanceNucleicAcid
summary: "search-type: Search for SubstanceNucleicAcid instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/SubstanceNucleicAcid/$validate:
get:
tags:
- SubstanceNucleicAcid
summary: "GET: /SubstanceNucleicAcid/$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:
- SubstanceNucleicAcid
summary: "POST: /SubstanceNucleicAcid/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "SubstanceNucleicAcid",
"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"
/SubstanceNucleicAcid/{id}/$validate:
get:
tags:
- SubstanceNucleicAcid
summary: "GET: /SubstanceNucleicAcid/{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:
- SubstanceNucleicAcid
summary: "POST: /SubstanceNucleicAcid/{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": "SubstanceNucleicAcid",
"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"
/SubstanceNucleicAcid/{id}/$meta-delete:
post:
tags:
- SubstanceNucleicAcid
summary: "POST: /SubstanceNucleicAcid/{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"
/SubstanceNucleicAcid/{id}/$meta-add:
post:
tags:
- SubstanceNucleicAcid
summary: "POST: /SubstanceNucleicAcid/{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"
/SubstanceNucleicAcid/$meta:
get:
tags:
- SubstanceNucleicAcid
summary: "GET: /SubstanceNucleicAcid/$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:
- SubstanceNucleicAcid
summary: "POST: /SubstanceNucleicAcid/$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"
/SubstanceNucleicAcid/{id}/$meta:
get:
tags:
- SubstanceNucleicAcid
summary: "GET: /SubstanceNucleicAcid/{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:
- SubstanceNucleicAcid
summary: "POST: /SubstanceNucleicAcid/{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"
/SubstanceNucleicAcid/$expunge:
post:
tags:
- SubstanceNucleicAcid
summary: "POST: /SubstanceNucleicAcid/$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"
/SubstanceNucleicAcid/{id}/$expunge:
post:
tags:
- SubstanceNucleicAcid
summary: "POST: /SubstanceNucleicAcid/{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"
/SubstanceNucleicAcid/{id}/$diff:
get:
tags:
- SubstanceNucleicAcid
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:
- SubstanceNucleicAcid
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"
/SubstancePolymer/{id}:
get:
tags:
- SubstancePolymer
summary: "read-instance: Read SubstancePolymer instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- SubstancePolymer
summary: "update-instance: Update an existing SubstancePolymer instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SubstancePolymer"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- SubstancePolymer
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- SubstancePolymer
summary: "instance-patch: Patch a resource instance of type SubstancePolymer\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstancePolymer/{id}/_history/{version_id}:
get:
tags:
- SubstancePolymer
summary: "vread-instance: Read SubstancePolymer instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstancePolymer:
get:
tags:
- SubstancePolymer
summary: "search-type: Search for SubstancePolymer instances"
description: This is a search type
parameters:
- name: _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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- SubstancePolymer
summary: "create-type: Create a new SubstancePolymer instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SubstancePolymer"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstancePolymer/_history:
get:
tags:
- SubstancePolymer
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubstancePolymer"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstancePolymer/{id}/_history:
get:
tags:
- SubstancePolymer
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubstancePolymer"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstancePolymer/_search:
get:
tags:
- SubstancePolymer
summary: "search-type: Search for SubstancePolymer instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/SubstancePolymer/$validate:
get:
tags:
- SubstancePolymer
summary: "GET: /SubstancePolymer/$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:
- SubstancePolymer
summary: "POST: /SubstancePolymer/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "SubstancePolymer",
"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"
/SubstancePolymer/{id}/$validate:
get:
tags:
- SubstancePolymer
summary: "GET: /SubstancePolymer/{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:
- SubstancePolymer
summary: "POST: /SubstancePolymer/{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": "SubstancePolymer",
"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"
/SubstancePolymer/{id}/$meta-delete:
post:
tags:
- SubstancePolymer
summary: "POST: /SubstancePolymer/{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"
/SubstancePolymer/{id}/$meta-add:
post:
tags:
- SubstancePolymer
summary: "POST: /SubstancePolymer/{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"
/SubstancePolymer/$meta:
get:
tags:
- SubstancePolymer
summary: "GET: /SubstancePolymer/$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:
- SubstancePolymer
summary: "POST: /SubstancePolymer/$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"
/SubstancePolymer/{id}/$meta:
get:
tags:
- SubstancePolymer
summary: "GET: /SubstancePolymer/{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:
- SubstancePolymer
summary: "POST: /SubstancePolymer/{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"
/SubstancePolymer/$expunge:
post:
tags:
- SubstancePolymer
summary: "POST: /SubstancePolymer/$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"
/SubstancePolymer/{id}/$expunge:
post:
tags:
- SubstancePolymer
summary: "POST: /SubstancePolymer/{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"
/SubstancePolymer/{id}/$diff:
get:
tags:
- SubstancePolymer
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:
- SubstancePolymer
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"
/SubstanceProtein/{id}:
get:
tags:
- SubstanceProtein
summary: "read-instance: Read SubstanceProtein instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- SubstanceProtein
summary: "update-instance: Update an existing SubstanceProtein instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SubstanceProtein"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- SubstanceProtein
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- SubstanceProtein
summary: "instance-patch: Patch a resource instance of type SubstanceProtein\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceProtein/{id}/_history/{version_id}:
get:
tags:
- SubstanceProtein
summary: "vread-instance: Read SubstanceProtein instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceProtein:
get:
tags:
- SubstanceProtein
summary: "search-type: Search for SubstanceProtein instances"
description: This is a search type
parameters:
- name: _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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- SubstanceProtein
summary: "create-type: Create a new SubstanceProtein instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SubstanceProtein"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceProtein/_history:
get:
tags:
- SubstanceProtein
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubstanceProtein"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceProtein/{id}/_history:
get:
tags:
- SubstanceProtein
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubstanceProtein"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceProtein/_search:
get:
tags:
- SubstanceProtein
summary: "search-type: Search for SubstanceProtein instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/SubstanceProtein/$validate:
get:
tags:
- SubstanceProtein
summary: "GET: /SubstanceProtein/$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:
- SubstanceProtein
summary: "POST: /SubstanceProtein/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "SubstanceProtein",
"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"
/SubstanceProtein/{id}/$validate:
get:
tags:
- SubstanceProtein
summary: "GET: /SubstanceProtein/{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:
- SubstanceProtein
summary: "POST: /SubstanceProtein/{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": "SubstanceProtein",
"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"
/SubstanceProtein/{id}/$meta-delete:
post:
tags:
- SubstanceProtein
summary: "POST: /SubstanceProtein/{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"
/SubstanceProtein/{id}/$meta-add:
post:
tags:
- SubstanceProtein
summary: "POST: /SubstanceProtein/{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"
/SubstanceProtein/$meta:
get:
tags:
- SubstanceProtein
summary: "GET: /SubstanceProtein/$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:
- SubstanceProtein
summary: "POST: /SubstanceProtein/$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"
/SubstanceProtein/{id}/$meta:
get:
tags:
- SubstanceProtein
summary: "GET: /SubstanceProtein/{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:
- SubstanceProtein
summary: "POST: /SubstanceProtein/{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"
/SubstanceProtein/$expunge:
post:
tags:
- SubstanceProtein
summary: "POST: /SubstanceProtein/$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"
/SubstanceProtein/{id}/$expunge:
post:
tags:
- SubstanceProtein
summary: "POST: /SubstanceProtein/{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"
/SubstanceProtein/{id}/$diff:
get:
tags:
- SubstanceProtein
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:
- SubstanceProtein
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"
/SubstanceReferenceInformation/{id}:
get:
tags:
- SubstanceReferenceInformation
summary: "read-instance: Read SubstanceReferenceInformation instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- SubstanceReferenceInformation
summary: "update-instance: Update an existing SubstanceReferenceInformation\
\ instance, or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SubstanceReferenceInformation"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- SubstanceReferenceInformation
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- SubstanceReferenceInformation
summary: "instance-patch: Patch a resource instance of type SubstanceReferenceInformation\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceReferenceInformation/{id}/_history/{version_id}:
get:
tags:
- SubstanceReferenceInformation
summary: "vread-instance: Read SubstanceReferenceInformation instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceReferenceInformation:
get:
tags:
- SubstanceReferenceInformation
summary: "search-type: Search for SubstanceReferenceInformation instances"
description: This is a search type
parameters:
- name: _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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- SubstanceReferenceInformation
summary: "create-type: Create a new SubstanceReferenceInformation instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SubstanceReferenceInformation"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceReferenceInformation/_history:
get:
tags:
- SubstanceReferenceInformation
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubstanceReferenceInformation"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceReferenceInformation/{id}/_history:
get:
tags:
- SubstanceReferenceInformation
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubstanceReferenceInformation"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceReferenceInformation/_search:
get:
tags:
- SubstanceReferenceInformation
summary: "search-type: Search for SubstanceReferenceInformation instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/SubstanceReferenceInformation/$validate:
get:
tags:
- SubstanceReferenceInformation
summary: "GET: /SubstanceReferenceInformation/$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:
- SubstanceReferenceInformation
summary: "POST: /SubstanceReferenceInformation/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "SubstanceReferenceInformation",
"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"
/SubstanceReferenceInformation/{id}/$validate:
get:
tags:
- SubstanceReferenceInformation
summary: "GET: /SubstanceReferenceInformation/{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:
- SubstanceReferenceInformation
summary: "POST: /SubstanceReferenceInformation/{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": "SubstanceReferenceInformation",
"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"
/SubstanceReferenceInformation/{id}/$meta-delete:
post:
tags:
- SubstanceReferenceInformation
summary: "POST: /SubstanceReferenceInformation/{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"
/SubstanceReferenceInformation/{id}/$meta-add:
post:
tags:
- SubstanceReferenceInformation
summary: "POST: /SubstanceReferenceInformation/{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"
/SubstanceReferenceInformation/$meta:
get:
tags:
- SubstanceReferenceInformation
summary: "GET: /SubstanceReferenceInformation/$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:
- SubstanceReferenceInformation
summary: "POST: /SubstanceReferenceInformation/$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"
/SubstanceReferenceInformation/{id}/$meta:
get:
tags:
- SubstanceReferenceInformation
summary: "GET: /SubstanceReferenceInformation/{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:
- SubstanceReferenceInformation
summary: "POST: /SubstanceReferenceInformation/{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"
/SubstanceReferenceInformation/$expunge:
post:
tags:
- SubstanceReferenceInformation
summary: "POST: /SubstanceReferenceInformation/$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"
/SubstanceReferenceInformation/{id}/$expunge:
post:
tags:
- SubstanceReferenceInformation
summary: "POST: /SubstanceReferenceInformation/{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"
/SubstanceReferenceInformation/{id}/$diff:
get:
tags:
- SubstanceReferenceInformation
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:
- SubstanceReferenceInformation
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"
/SubstanceSourceMaterial/{id}:
get:
tags:
- SubstanceSourceMaterial
summary: "read-instance: Read SubstanceSourceMaterial instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- SubstanceSourceMaterial
summary: "update-instance: Update an existing SubstanceSourceMaterial instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SubstanceSourceMaterial"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- SubstanceSourceMaterial
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- SubstanceSourceMaterial
summary: "instance-patch: Patch a resource instance of type SubstanceSourceMaterial\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceSourceMaterial/{id}/_history/{version_id}:
get:
tags:
- SubstanceSourceMaterial
summary: "vread-instance: Read SubstanceSourceMaterial instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceSourceMaterial:
get:
tags:
- SubstanceSourceMaterial
summary: "search-type: Search for SubstanceSourceMaterial instances"
description: This is a search type
parameters:
- name: _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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- SubstanceSourceMaterial
summary: "create-type: Create a new SubstanceSourceMaterial instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SubstanceSourceMaterial"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceSourceMaterial/_history:
get:
tags:
- SubstanceSourceMaterial
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubstanceSourceMaterial"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceSourceMaterial/{id}/_history:
get:
tags:
- SubstanceSourceMaterial
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubstanceSourceMaterial"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceSourceMaterial/_search:
get:
tags:
- SubstanceSourceMaterial
summary: "search-type: Search for SubstanceSourceMaterial instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/SubstanceSourceMaterial/$validate:
get:
tags:
- SubstanceSourceMaterial
summary: "GET: /SubstanceSourceMaterial/$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:
- SubstanceSourceMaterial
summary: "POST: /SubstanceSourceMaterial/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "SubstanceSourceMaterial",
"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"
/SubstanceSourceMaterial/{id}/$validate:
get:
tags:
- SubstanceSourceMaterial
summary: "GET: /SubstanceSourceMaterial/{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:
- SubstanceSourceMaterial
summary: "POST: /SubstanceSourceMaterial/{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": "SubstanceSourceMaterial",
"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"
/SubstanceSourceMaterial/{id}/$meta-delete:
post:
tags:
- SubstanceSourceMaterial
summary: "POST: /SubstanceSourceMaterial/{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"
/SubstanceSourceMaterial/{id}/$meta-add:
post:
tags:
- SubstanceSourceMaterial
summary: "POST: /SubstanceSourceMaterial/{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"
/SubstanceSourceMaterial/$meta:
get:
tags:
- SubstanceSourceMaterial
summary: "GET: /SubstanceSourceMaterial/$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:
- SubstanceSourceMaterial
summary: "POST: /SubstanceSourceMaterial/$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"
/SubstanceSourceMaterial/{id}/$meta:
get:
tags:
- SubstanceSourceMaterial
summary: "GET: /SubstanceSourceMaterial/{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:
- SubstanceSourceMaterial
summary: "POST: /SubstanceSourceMaterial/{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"
/SubstanceSourceMaterial/$expunge:
post:
tags:
- SubstanceSourceMaterial
summary: "POST: /SubstanceSourceMaterial/$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"
/SubstanceSourceMaterial/{id}/$expunge:
post:
tags:
- SubstanceSourceMaterial
summary: "POST: /SubstanceSourceMaterial/{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"
/SubstanceSourceMaterial/{id}/$diff:
get:
tags:
- SubstanceSourceMaterial
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:
- SubstanceSourceMaterial
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"
/SubstanceSpecification/{id}:
get:
tags:
- SubstanceSpecification
summary: "read-instance: Read SubstanceSpecification instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- SubstanceSpecification
summary: "update-instance: Update an existing SubstanceSpecification 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": "SubstanceSpecification"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"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:
- SubstanceSpecification
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:
- SubstanceSpecification
summary: "instance-patch: Patch a resource instance of type SubstanceSpecification\
\ 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"
/SubstanceSpecification/{id}/_history/{version_id}:
get:
tags:
- SubstanceSpecification
summary: "vread-instance: Read SubstanceSpecification instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceSpecification:
get:
tags:
- SubstanceSpecification
summary: "search-type: Search for SubstanceSpecification instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: code
in: query
description: The specific code
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
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: _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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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:
- SubstanceSpecification
summary: "create-type: Create a new SubstanceSpecification instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SubstanceSpecification"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceSpecification/_history:
get:
tags:
- SubstanceSpecification
summary: "type-history: Fetch the resource change history for all resources\
\ of type SubstanceSpecification"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceSpecification/{id}/_history:
get:
tags:
- SubstanceSpecification
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SubstanceSpecification"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SubstanceSpecification/_search:
get:
tags:
- SubstanceSpecification
summary: "search-type: Search for SubstanceSpecification instances"
description: This is a search type
parameters:
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: code
in: query
description: The specific code
required: false
schema:
type: string
- name: _profile
in: query
description: Profiles this resource claims to conform to
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: _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: _security
in: query
description: Security Labels applied to this resource
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: _filter
in: query
description: Search the contents of the resource's data using a filter
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"
/SubstanceSpecification/$validate:
get:
tags:
- SubstanceSpecification
summary: "GET: /SubstanceSpecification/$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:
- SubstanceSpecification
summary: "POST: /SubstanceSpecification/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "SubstanceSpecification",
"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"
/SubstanceSpecification/{id}/$validate:
get:
tags:
- SubstanceSpecification
summary: "GET: /SubstanceSpecification/{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:
- SubstanceSpecification
summary: "POST: /SubstanceSpecification/{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": "SubstanceSpecification",
"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"
/SubstanceSpecification/{id}/$meta-delete:
post:
tags:
- SubstanceSpecification
summary: "POST: /SubstanceSpecification/{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"
/SubstanceSpecification/{id}/$meta-add:
post:
tags:
- SubstanceSpecification
summary: "POST: /SubstanceSpecification/{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"
/SubstanceSpecification/$meta:
get:
tags:
- SubstanceSpecification
summary: "GET: /SubstanceSpecification/$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:
- SubstanceSpecification
summary: "POST: /SubstanceSpecification/$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"
/SubstanceSpecification/{id}/$meta:
get:
tags:
- SubstanceSpecification
summary: "GET: /SubstanceSpecification/{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:
- SubstanceSpecification
summary: "POST: /SubstanceSpecification/{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"
/SubstanceSpecification/$expunge:
post:
tags:
- SubstanceSpecification
summary: "POST: /SubstanceSpecification/$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"
/SubstanceSpecification/{id}/$expunge:
post:
tags:
- SubstanceSpecification
summary: "POST: /SubstanceSpecification/{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"
/SubstanceSpecification/{id}/$diff:
get:
tags:
- SubstanceSpecification
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:
- SubstanceSpecification
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"
/SupplyDelivery/{id}:
get:
tags:
- SupplyDelivery
summary: "read-instance: Read SupplyDelivery instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- SupplyDelivery
summary: "update-instance: Update an existing SupplyDelivery instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SupplyDelivery"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- SupplyDelivery
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- SupplyDelivery
summary: "instance-patch: Patch a resource instance of type SupplyDelivery by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SupplyDelivery/{id}/_history/{version_id}:
get:
tags:
- SupplyDelivery
summary: "vread-instance: Read SupplyDelivery instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SupplyDelivery:
get:
tags:
- SupplyDelivery
summary: "search-type: Search for SupplyDelivery instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: receiver
in: query
description: Who collected the Supply
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: supplier
in: query
description: Dispenser
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: in-progress | completed | abandoned | entered-in-error
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:
- SupplyDelivery
summary: "create-type: Create a new SupplyDelivery instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SupplyDelivery"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SupplyDelivery/_history:
get:
tags:
- SupplyDelivery
summary: "type-history: Fetch the resource change history for all resources\
\ of type SupplyDelivery"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SupplyDelivery/{id}/_history:
get:
tags:
- SupplyDelivery
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SupplyDelivery"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SupplyDelivery/_search:
get:
tags:
- SupplyDelivery
summary: "search-type: Search for SupplyDelivery instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: receiver
in: query
description: Who collected the Supply
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
required: false
schema:
type: string
- name: _tag
in: query
description: Tags applied to this resource
required: false
schema:
type: string
- name: supplier
in: query
description: Dispenser
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: in-progress | completed | abandoned | entered-in-error
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"
/SupplyDelivery/$validate:
get:
tags:
- SupplyDelivery
summary: "GET: /SupplyDelivery/$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:
- SupplyDelivery
summary: "POST: /SupplyDelivery/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "SupplyDelivery",
"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"
/SupplyDelivery/{id}/$validate:
get:
tags:
- SupplyDelivery
summary: "GET: /SupplyDelivery/{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:
- SupplyDelivery
summary: "POST: /SupplyDelivery/{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": "SupplyDelivery",
"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"
/SupplyDelivery/{id}/$meta-delete:
post:
tags:
- SupplyDelivery
summary: "POST: /SupplyDelivery/{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"
/SupplyDelivery/{id}/$meta-add:
post:
tags:
- SupplyDelivery
summary: "POST: /SupplyDelivery/{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"
/SupplyDelivery/$meta:
get:
tags:
- SupplyDelivery
summary: "GET: /SupplyDelivery/$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:
- SupplyDelivery
summary: "POST: /SupplyDelivery/$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"
/SupplyDelivery/{id}/$meta:
get:
tags:
- SupplyDelivery
summary: "GET: /SupplyDelivery/{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:
- SupplyDelivery
summary: "POST: /SupplyDelivery/{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"
/SupplyDelivery/$expunge:
post:
tags:
- SupplyDelivery
summary: "POST: /SupplyDelivery/$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"
/SupplyDelivery/{id}/$expunge:
post:
tags:
- SupplyDelivery
summary: "POST: /SupplyDelivery/{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"
/SupplyDelivery/{id}/$diff:
get:
tags:
- SupplyDelivery
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:
- SupplyDelivery
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"
/SupplyRequest/{id}:
get:
tags:
- SupplyRequest
summary: "read-instance: Read SupplyRequest instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- SupplyRequest
summary: "update-instance: Update an existing SupplyRequest instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SupplyRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- SupplyRequest
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- SupplyRequest
summary: "instance-patch: Patch a resource instance of type SupplyRequest by\
\ ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SupplyRequest/{id}/_history/{version_id}:
get:
tags:
- SupplyRequest
summary: "vread-instance: Read SupplyRequest instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SupplyRequest:
get:
tags:
- SupplyRequest
summary: "search-type: Search for SupplyRequest instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: requester
in: query
description: Individual making the request
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: subject
in: query
description: The destination of the supply
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: supplier
in: query
description: Who is intended to fulfill the request
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: "The kind of supply (central, non-stock, etc.)"
required: false
schema:
type: string
- name: status
in: query
description: draft | active | suspended +
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:
- SupplyRequest
summary: "create-type: Create a new SupplyRequest instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "SupplyRequest"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SupplyRequest/_history:
get:
tags:
- SupplyRequest
summary: "type-history: Fetch the resource change history for all resources\
\ of type SupplyRequest"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SupplyRequest/{id}/_history:
get:
tags:
- SupplyRequest
summary: "instance-history: Fetch the resource change history for all resources\
\ of type SupplyRequest"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/SupplyRequest/_search:
get:
tags:
- SupplyRequest
summary: "search-type: Search for SupplyRequest instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html):\
\ Time period plan covers\r\n* [CareTeam](careteam.html): Time period team\
\ covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment\
\ was documented\r\n* [Composition](composition.html): Composition editing\
\ time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\
\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time\
\ of the report\r\n* [Encounter](encounter.html): A date within the period\
\ the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided\
\ date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ When history was recorded or last updated\r\n* [Flag](flag.html): Time\
\ period when flag is active\r\n* [Immunization](immunization.html): Vaccination\
\ (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\
\n* [Observation](observation.html): Obtained date/time. If the obtained\
\ element is a period, a date that falls in the period\r\n* [Procedure](procedure.html):\
\ When the procedure was performed\r\n* [RiskAssessment](riskassessment.html):\
\ When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When\
\ the request was made"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: requester
in: query
description: Individual making the request
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
required: false
schema:
type: string
- name: subject
in: query
description: The destination of the supply
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: supplier
in: query
description: Who is intended to fulfill the request
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: "The kind of supply (central, non-stock, etc.)"
required: false
schema:
type: string
- name: status
in: query
description: draft | active | suspended +
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"
/SupplyRequest/$validate:
get:
tags:
- SupplyRequest
summary: "GET: /SupplyRequest/$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:
- SupplyRequest
summary: "POST: /SupplyRequest/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "SupplyRequest",
"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"
/SupplyRequest/{id}/$validate:
get:
tags:
- SupplyRequest
summary: "GET: /SupplyRequest/{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:
- SupplyRequest
summary: "POST: /SupplyRequest/{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": "SupplyRequest",
"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"
/SupplyRequest/{id}/$meta-delete:
post:
tags:
- SupplyRequest
summary: "POST: /SupplyRequest/{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"
/SupplyRequest/{id}/$meta-add:
post:
tags:
- SupplyRequest
summary: "POST: /SupplyRequest/{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"
/SupplyRequest/$meta:
get:
tags:
- SupplyRequest
summary: "GET: /SupplyRequest/$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:
- SupplyRequest
summary: "POST: /SupplyRequest/$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"
/SupplyRequest/{id}/$meta:
get:
tags:
- SupplyRequest
summary: "GET: /SupplyRequest/{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:
- SupplyRequest
summary: "POST: /SupplyRequest/{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"
/SupplyRequest/$expunge:
post:
tags:
- SupplyRequest
summary: "POST: /SupplyRequest/$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"
/SupplyRequest/{id}/$expunge:
post:
tags:
- SupplyRequest
summary: "POST: /SupplyRequest/{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"
/SupplyRequest/{id}/$diff:
get:
tags:
- SupplyRequest
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:
- SupplyRequest
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"
/Task/{id}:
get:
tags:
- Task
summary: "read-instance: Read Task instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- Task
summary: "update-instance: Update an existing Task instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Task"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- Task
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- Task
summary: "instance-patch: Patch a resource instance of type Task by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Task/{id}/_history/{version_id}:
get:
tags:
- Task
summary: "vread-instance: Read Task instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Task:
get:
tags:
- Task
summary: "search-type: Search for Task instances"
description: This is a search type
parameters:
- name: code
in: query
description: Search by task code
required: false
schema:
type: string
- name: subject
in: query
description: Search by subject
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: focus
in: query
description: Search by task focus
required: false
schema:
type: string
- name: part-of
in: query
description: Search by task this task is part of
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: group-identifier
in: query
description: Search by group identifier
required: false
schema:
type: string
- name: based-on
in: query
description: Search by requests this task is based on
required: false
schema:
type: string
- name: patient
in: query
description: Search by patient
required: false
schema:
type: string
- name: modified
in: query
description: Search by last modification date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: owner
in: query
description: Search by task owner
required: false
schema:
type: string
- name: requester
in: query
description: Search by task requester
required: false
schema:
type: string
- name: business-status
in: query
description: Search by business status
required: false
schema:
type: string
- name: identifier
in: query
description: Search for a task instance by its business identifier
required: false
schema:
type: string
- name: period
in: query
description: Search by period Task is/was underway
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: performer
in: query
description: "Search by recommended type of performer (e.g., Requester, Performer,\
\ Scheduler)."
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: Search by encounter
required: false
schema:
type: string
- name: authored-on
in: query
description: Search by creation date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: priority
in: query
description: Search by task priority
required: false
schema:
type: string
- name: intent
in: query
description: Search by task intent
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: status
in: query
description: Search by task status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- Task
summary: "create-type: Create a new Task instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Task"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Task/_history:
get:
tags:
- Task
summary: "type-history: Fetch the resource change history for all resources\
\ of type Task"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Task/{id}/_history:
get:
tags:
- Task
summary: "instance-history: Fetch the resource change history for all resources\
\ of type Task"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Task/_search:
get:
tags:
- Task
summary: "search-type: Search for Task instances"
description: This is a search type
parameters:
- name: code
in: query
description: Search by task code
required: false
schema:
type: string
- name: subject
in: query
description: Search by subject
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: focus
in: query
description: Search by task focus
required: false
schema:
type: string
- name: part-of
in: query
description: Search by task this task is part of
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: group-identifier
in: query
description: Search by group identifier
required: false
schema:
type: string
- name: based-on
in: query
description: Search by requests this task is based on
required: false
schema:
type: string
- name: patient
in: query
description: Search by patient
required: false
schema:
type: string
- name: modified
in: query
description: Search by last modification date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: owner
in: query
description: Search by task owner
required: false
schema:
type: string
- name: requester
in: query
description: Search by task requester
required: false
schema:
type: string
- name: business-status
in: query
description: Search by business status
required: false
schema:
type: string
- name: identifier
in: query
description: Search for a task instance by its business identifier
required: false
schema:
type: string
- name: period
in: query
description: Search by period Task is/was underway
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: performer
in: query
description: "Search by recommended type of performer (e.g., Requester, Performer,\
\ Scheduler)."
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: Search by encounter
required: false
schema:
type: string
- name: authored-on
in: query
description: Search by creation date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: priority
in: query
description: Search by task priority
required: false
schema:
type: string
- name: intent
in: query
description: Search by task intent
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: status
in: query
description: Search by task status
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/Task/$validate:
get:
tags:
- Task
summary: "GET: /Task/$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:
- Task
summary: "POST: /Task/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "Task",
"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"
/Task/{id}/$validate:
get:
tags:
- Task
summary: "GET: /Task/{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:
- Task
summary: "POST: /Task/{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": "Task",
"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"
/Task/{id}/$meta-delete:
post:
tags:
- Task
summary: "POST: /Task/{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"
/Task/{id}/$meta-add:
post:
tags:
- Task
summary: "POST: /Task/{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"
/Task/$meta:
get:
tags:
- Task
summary: "GET: /Task/$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:
- Task
summary: "POST: /Task/$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"
/Task/{id}/$meta:
get:
tags:
- Task
summary: "GET: /Task/{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:
- Task
summary: "POST: /Task/{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"
/Task/$expunge:
post:
tags:
- Task
summary: "POST: /Task/$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"
/Task/{id}/$expunge:
post:
tags:
- Task
summary: "POST: /Task/{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"
/Task/{id}/$diff:
get:
tags:
- Task
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:
- Task
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"
/TerminologyCapabilities/{id}:
get:
tags:
- TerminologyCapabilities
summary: "read-instance: Read TerminologyCapabilities instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- TerminologyCapabilities
summary: "update-instance: Update an existing TerminologyCapabilities instance,\
\ or create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "TerminologyCapabilities"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- TerminologyCapabilities
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- TerminologyCapabilities
summary: "instance-patch: Patch a resource instance of type TerminologyCapabilities\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TerminologyCapabilities/{id}/_history/{version_id}:
get:
tags:
- TerminologyCapabilities
summary: "vread-instance: Read TerminologyCapabilities instance with specific\
\ version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TerminologyCapabilities:
get:
tags:
- TerminologyCapabilities
summary: "search-type: Search for TerminologyCapabilities instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- TerminologyCapabilities
summary: "create-type: Create a new TerminologyCapabilities instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "TerminologyCapabilities"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TerminologyCapabilities/_history:
get:
tags:
- TerminologyCapabilities
summary: "type-history: Fetch the resource change history for all resources\
\ of type TerminologyCapabilities"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TerminologyCapabilities/{id}/_history:
get:
tags:
- TerminologyCapabilities
summary: "instance-history: Fetch the resource change history for all resources\
\ of type TerminologyCapabilities"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TerminologyCapabilities/_search:
get:
tags:
- TerminologyCapabilities
summary: "search-type: Search for TerminologyCapabilities instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: _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* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: name
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TerminologyCapabilities/$validate:
get:
tags:
- TerminologyCapabilities
summary: "GET: /TerminologyCapabilities/$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:
- TerminologyCapabilities
summary: "POST: /TerminologyCapabilities/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "TerminologyCapabilities",
"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"
/TerminologyCapabilities/{id}/$validate:
get:
tags:
- TerminologyCapabilities
summary: "GET: /TerminologyCapabilities/{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:
- TerminologyCapabilities
summary: "POST: /TerminologyCapabilities/{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": "TerminologyCapabilities",
"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"
/TerminologyCapabilities/{id}/$meta-delete:
post:
tags:
- TerminologyCapabilities
summary: "POST: /TerminologyCapabilities/{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"
/TerminologyCapabilities/{id}/$meta-add:
post:
tags:
- TerminologyCapabilities
summary: "POST: /TerminologyCapabilities/{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"
/TerminologyCapabilities/$meta:
get:
tags:
- TerminologyCapabilities
summary: "GET: /TerminologyCapabilities/$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:
- TerminologyCapabilities
summary: "POST: /TerminologyCapabilities/$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"
/TerminologyCapabilities/{id}/$meta:
get:
tags:
- TerminologyCapabilities
summary: "GET: /TerminologyCapabilities/{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:
- TerminologyCapabilities
summary: "POST: /TerminologyCapabilities/{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"
/TerminologyCapabilities/$expunge:
post:
tags:
- TerminologyCapabilities
summary: "POST: /TerminologyCapabilities/$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"
/TerminologyCapabilities/{id}/$expunge:
post:
tags:
- TerminologyCapabilities
summary: "POST: /TerminologyCapabilities/{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"
/TerminologyCapabilities/{id}/$diff:
get:
tags:
- TerminologyCapabilities
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:
- TerminologyCapabilities
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"
/TestReport/{id}:
get:
tags:
- TestReport
summary: "read-instance: Read TestReport instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- TestReport
summary: "update-instance: Update an existing TestReport instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "TestReport"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- TestReport
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- TestReport
summary: "instance-patch: Patch a resource instance of type TestReport by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TestReport/{id}/_history/{version_id}:
get:
tags:
- TestReport
summary: "vread-instance: Read TestReport instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TestReport:
get:
tags:
- TestReport
summary: "search-type: Search for TestReport instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: An external identifier for the test report
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: tester
in: query
description: The name of the testing organization
required: false
schema:
type: string
- name: participant
in: query
description: The reference to a participant in the test execution
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: result
in: query
description: The result disposition of the test execution
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: testscript
in: query
description: The test script executed to produce this report
required: false
schema:
type: string
- name: issued
in: query
description: The test report generation date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- TestReport
summary: "create-type: Create a new TestReport instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "TestReport"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TestReport/_history:
get:
tags:
- TestReport
summary: "type-history: Fetch the resource change history for all resources\
\ of type TestReport"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TestReport/{id}/_history:
get:
tags:
- TestReport
summary: "instance-history: Fetch the resource change history for all resources\
\ of type TestReport"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TestReport/_search:
get:
tags:
- TestReport
summary: "search-type: Search for TestReport instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: An external identifier for the test report
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: tester
in: query
description: The name of the testing organization
required: false
schema:
type: string
- name: participant
in: query
description: The reference to a participant in the test execution
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: result
in: query
description: The result disposition of the test execution
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: testscript
in: query
description: The test script executed to produce this report
required: false
schema:
type: string
- name: issued
in: query
description: The test report generation date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TestReport/$validate:
get:
tags:
- TestReport
summary: "GET: /TestReport/$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:
- TestReport
summary: "POST: /TestReport/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "TestReport",
"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"
/TestReport/{id}/$validate:
get:
tags:
- TestReport
summary: "GET: /TestReport/{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:
- TestReport
summary: "POST: /TestReport/{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": "TestReport",
"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"
/TestReport/{id}/$meta-delete:
post:
tags:
- TestReport
summary: "POST: /TestReport/{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"
/TestReport/{id}/$meta-add:
post:
tags:
- TestReport
summary: "POST: /TestReport/{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"
/TestReport/$meta:
get:
tags:
- TestReport
summary: "GET: /TestReport/$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:
- TestReport
summary: "POST: /TestReport/$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"
/TestReport/{id}/$meta:
get:
tags:
- TestReport
summary: "GET: /TestReport/{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:
- TestReport
summary: "POST: /TestReport/{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"
/TestReport/$expunge:
post:
tags:
- TestReport
summary: "POST: /TestReport/$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"
/TestReport/{id}/$expunge:
post:
tags:
- TestReport
summary: "POST: /TestReport/{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"
/TestReport/{id}/$diff:
get:
tags:
- TestReport
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:
- TestReport
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"
/TestScript/{id}:
get:
tags:
- TestScript
summary: "read-instance: Read TestScript instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- TestScript
summary: "update-instance: Update an existing TestScript instance, or create\
\ using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "TestScript"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- TestScript
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- TestScript
summary: "instance-patch: Patch a resource instance of type TestScript by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TestScript/{id}/_history/{version_id}:
get:
tags:
- TestScript
summary: "vread-instance: Read TestScript instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TestScript:
get:
tags:
- TestScript
summary: "search-type: Search for TestScript instances"
description: This is a search type
parameters:
- name: date
in: query
description: The test script publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: A use context type and value assigned to the test script
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the test script
required: false
schema:
type: string
- name: description
in: query
description: The description of the test script
required: false
schema:
type: string
- name: testscript-capability
in: query
description: TestScript required and validated capability
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the test script
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the test script
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: A quantity- or range-valued use context assigned to the test
script
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: A use context assigned to the test script
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the test script
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the test script
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: The business version of the test script
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the test script
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: Computationally friendly name of the test script
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the test script
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 test script
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:
- TestScript
summary: "create-type: Create a new TestScript instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "TestScript"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TestScript/_history:
get:
tags:
- TestScript
summary: "type-history: Fetch the resource change history for all resources\
\ of type TestScript"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TestScript/{id}/_history:
get:
tags:
- TestScript
summary: "instance-history: Fetch the resource change history for all resources\
\ of type TestScript"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/TestScript/_search:
get:
tags:
- TestScript
summary: "search-type: Search for TestScript instances"
description: This is a search type
parameters:
- name: date
in: query
description: The test script publication date
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: context-type-value
in: query
description: A use context type and value assigned to the test script
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: Intended jurisdiction for the test script
required: false
schema:
type: string
- name: description
in: query
description: The description of the test script
required: false
schema:
type: string
- name: testscript-capability
in: query
description: TestScript required and validated capability
required: false
schema:
type: string
- name: context-type
in: query
description: A type of use context assigned to the test script
required: false
schema:
type: string
- name: title
in: query
description: The human-friendly name of the test script
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: A quantity- or range-valued use context assigned to the test
script
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: A use context assigned to the test script
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: A use context type and quantity- or range-based value assigned
to the test script
required: false
schema:
type: string
- name: identifier
in: query
description: External identifier for the test script
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: The business version of the test script
required: false
schema:
type: string
- name: url
in: query
description: The uri that identifies the test script
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: Computationally friendly name of the test script
required: false
schema:
type: string
- name: publisher
in: query
description: Name of the publisher of the test script
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 test script
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"
/TestScript/$validate:
get:
tags:
- TestScript
summary: "GET: /TestScript/$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:
- TestScript
summary: "POST: /TestScript/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "TestScript",
"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"
/TestScript/{id}/$validate:
get:
tags:
- TestScript
summary: "GET: /TestScript/{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:
- TestScript
summary: "POST: /TestScript/{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": "TestScript",
"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"
/TestScript/{id}/$meta-delete:
post:
tags:
- TestScript
summary: "POST: /TestScript/{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"
/TestScript/{id}/$meta-add:
post:
tags:
- TestScript
summary: "POST: /TestScript/{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"
/TestScript/$meta:
get:
tags:
- TestScript
summary: "GET: /TestScript/$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:
- TestScript
summary: "POST: /TestScript/$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"
/TestScript/{id}/$meta:
get:
tags:
- TestScript
summary: "GET: /TestScript/{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:
- TestScript
summary: "POST: /TestScript/{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"
/TestScript/$expunge:
post:
tags:
- TestScript
summary: "POST: /TestScript/$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"
/TestScript/{id}/$expunge:
post:
tags:
- TestScript
summary: "POST: /TestScript/{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"
/TestScript/{id}/$diff:
get:
tags:
- TestScript
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:
- TestScript
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ValueSet/{id}:
get:
tags:
- ValueSet
summary: "read-instance: Read ValueSet instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- ValueSet
summary: "update-instance: Update an existing ValueSet instance, or create using\
\ a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ValueSet"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- ValueSet
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- ValueSet
summary: "instance-patch: Patch a resource instance of type ValueSet by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ValueSet/{id}/_history/{version_id}:
get:
tags:
- ValueSet
summary: "vread-instance: Read ValueSet instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ValueSet:
get:
tags:
- ValueSet
summary: "search-type: Search for ValueSet instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: This special parameter searches for codes in the value set. See
additional notes on the ValueSet resource
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: reference
in: query
description: A code system included or excluded in the value set or an imported
value set
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\
\ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\
\ External identifier for the structure map\r\n* [ValueSet](valueset.html):\
\ External identifier for the value set"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: expansion
in: query
description: Identifies the value set expansion (business identifier)
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* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- ValueSet
summary: "create-type: Create a new ValueSet instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "ValueSet"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ValueSet/_history:
get:
tags:
- ValueSet
summary: "type-history: Fetch the resource change history for all resources\
\ of type ValueSet"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ValueSet/{id}/_history:
get:
tags:
- ValueSet
summary: "instance-history: Fetch the resource change history for all resources\
\ of type ValueSet"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ValueSet/_search:
get:
tags:
- ValueSet
summary: "search-type: Search for ValueSet instances"
description: This is a search type
parameters:
- name: date
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The capability statement publication date\r\n* [CodeSystem](codesystem.html):\
\ The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The compartment definition publication date\r\n* [ConceptMap](conceptmap.html):\
\ The concept map publication date\r\n* [GraphDefinition](graphdefinition.html):\
\ The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html):\
\ The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html):\
\ The message definition publication date\r\n* [NamingSystem](namingsystem.html):\
\ The naming system publication date\r\n* [OperationDefinition](operationdefinition.html):\
\ The operation definition publication date\r\n* [SearchParameter](searchparameter.html):\
\ The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html):\
\ The structure definition publication date\r\n* [StructureMap](structuremap.html):\
\ The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The terminology capabilities publication date\r\n* [ValueSet](valueset.html):\
\ The value set publication date"
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: code
in: query
description: This special parameter searches for codes in the value set. See
additional notes on the ValueSet resource
required: false
schema:
type: string
- name: context-type-value
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and value assigned to the capability statement\r\n\
* [CodeSystem](codesystem.html): A use context type and value assigned to\
\ the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context type and value assigned to the compartment definition\r\n\
* [ConceptMap](conceptmap.html): A use context type and value assigned to\
\ the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context\
\ type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and value assigned to the implementation guide\r\n\
* [MessageDefinition](messagedefinition.html): A use context type and value\
\ assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context type and value assigned to the operation definition\r\n\
* [SearchParameter](searchparameter.html): A use context type and value\
\ assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and value assigned to the structure definition\r\n\
* [StructureMap](structuremap.html): A use context type and value assigned\
\ to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context type and value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and value assigned to\
\ the value set"
required: false
schema:
type: string
- name: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- name: jurisdiction
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html):\
\ Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html):\
\ Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Intended jurisdiction for the value set"
required: false
schema:
type: string
- name: description
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The description of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The description of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The description of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The description of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The description of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The description of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The description of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The description of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The description of the value set"
required: false
schema:
type: string
- name: context-type
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A type of use context assigned to the value set"
required: false
schema:
type: string
- name: title
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html):\
\ The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html):\
\ The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html):\
\ The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The human-friendly name of the value set"
required: false
schema:
type: string
- name: reference
in: query
description: A code system included or excluded in the value set or an imported
value set
required: false
schema:
type: string
- name: _list
in: query
description: Search the contents of the resource's data using a list
required: false
schema:
type: string
- name: context-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A quantity- or range-valued use context assigned to the capability statement\r\
\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context\
\ assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A quantity- or range-valued use context assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context\
\ assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A quantity- or range-valued use context assigned to the graph definition\r\
\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued\
\ use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A quantity- or range-valued use context assigned to the message definition\r\
\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context\
\ assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A quantity- or range-valued use context assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A quantity- or range-valued\
\ use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A quantity- or range-valued use context assigned to the structure definition\r\
\n* [StructureMap](structuremap.html): A quantity- or range-valued use context\
\ assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A quantity- or range-valued use context assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned\
\ to the value set"
required: false
schema:
anyOf:
- type: string
- type: number
- name: context
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html):\
\ A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html):\
\ A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html):\
\ A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ A use context assigned to the value set"
required: false
schema:
type: string
- name: context-type-quantity
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ capability statement\r\n* [CodeSystem](codesystem.html): A use context\
\ type and quantity- or range-based value assigned to the code system\r\n\
* [CompartmentDefinition](compartmentdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the compartment definition\r\
\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based\
\ value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ message definition\r\n* [NamingSystem](namingsystem.html): A use context\
\ type and quantity- or range-based value assigned to the naming system\r\
\n* [OperationDefinition](operationdefinition.html): A use context type\
\ and quantity- or range-based value assigned to the operation definition\r\
\n* [SearchParameter](searchparameter.html): A use context type and quantity-\
\ or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ A use context type and quantity- or range-based value assigned to the\
\ structure definition\r\n* [StructureMap](structuremap.html): A use context\
\ type and quantity- or range-based value assigned to the structure map\r\
\n* [TerminologyCapabilities](terminologycapabilities.html): A use context\
\ type and quantity- or range-based value assigned to the terminology capabilities\r\
\n* [ValueSet](valueset.html): A use context type and quantity- or range-based\
\ value assigned to the value set"
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\
\ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\
\ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\
\ External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html):\
\ External identifier for the structure definition\r\n* [StructureMap](structuremap.html):\
\ External identifier for the structure map\r\n* [ValueSet](valueset.html):\
\ External identifier for the value set"
required: false
schema:
type: string
- name: _security
in: query
description: Security Labels applied to this resource
required: false
schema:
type: string
- name: version
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The business version of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The business version of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The business version of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The business version of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The business version of the value set"
required: false
schema:
type: string
- name: url
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html):\
\ The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html):\
\ The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The uri that identifies the value set"
required: false
schema:
type: string
- name: expansion
in: query
description: Identifies the value set expansion (business identifier)
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* [CapabilityStatement](capabilitystatement.html):\
\ Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Computationally friendly name of the value set"
required: false
schema:
type: string
- name: publisher
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html):\
\ Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ Name of the publisher of the value set"
required: false
schema:
type: string
- name: _source
in: query
description: Identifies where the resource comes from
required: false
schema:
type: string
- name: _id
in: query
description: Logical id of this artifact
required: false
schema:
type: string
- name: status
in: query
description: "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html):\
\ The current status of the capability statement\r\n* [CodeSystem](codesystem.html):\
\ The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html):\
\ The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html):\
\ The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html):\
\ The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html):\
\ The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html):\
\ The current status of the message definition\r\n* [NamingSystem](namingsystem.html):\
\ The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html):\
\ The current status of the operation definition\r\n* [SearchParameter](searchparameter.html):\
\ The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html):\
\ The current status of the structure definition\r\n* [StructureMap](structuremap.html):\
\ The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html):\
\ The current status of the terminology capabilities\r\n* [ValueSet](valueset.html):\
\ The current status of the value set"
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ValueSet/$validate-code:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/$validate-code"
parameters:
- name: url
in: query
required: false
schema:
type: string
- name: version
in: query
required: false
schema:
type: string
- name: code
in: query
required: false
schema:
type: string
- name: display
in: query
required: false
schema:
type: string
- name: coding
in: query
required: false
schema:
type: string
- name: valueSetVersion
in: query
required: false
schema:
type: string
- name: system
in: query
required: false
schema:
type: string
- name: systemVersion
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- ValueSet
summary: "POST: /ValueSet/$validate-code"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueUri": "example"
}, {
"name": "version",
"valueString": "example"
}, {
"name": "code",
"valueCode": "example"
}, {
"name": "display",
"valueString": "example"
}, {
"name": "coding",
"valueCoding": {
"system": "http://example.com",
"code": "1234"
}
}, {
"name": "codeableConcept",
"valueCodeableConcept": {
"coding": [ {
"system": "http://example.com",
"code": "1234"
} ]
}
}, {
"name": "valueSetVersion",
"valueString": "example"
}, {
"name": "system",
"valueUri": "example"
}, {
"name": "systemVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ValueSet/{id}/$validate-code:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/{id}/$validate-code"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: url
in: query
required: false
schema:
type: string
- name: version
in: query
required: false
schema:
type: string
- name: code
in: query
required: false
schema:
type: string
- name: display
in: query
required: false
schema:
type: string
- name: coding
in: query
required: false
schema:
type: string
- name: valueSetVersion
in: query
required: false
schema:
type: string
- name: system
in: query
required: false
schema:
type: string
- name: systemVersion
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- ValueSet
summary: "POST: /ValueSet/{id}/$validate-code"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueUri": "example"
}, {
"name": "version",
"valueString": "example"
}, {
"name": "code",
"valueCode": "example"
}, {
"name": "display",
"valueString": "example"
}, {
"name": "coding",
"valueCoding": {
"system": "http://example.com",
"code": "1234"
}
}, {
"name": "codeableConcept",
"valueCodeableConcept": {
"coding": [ {
"system": "http://example.com",
"code": "1234"
} ]
}
}, {
"name": "valueSetVersion",
"valueString": "example"
}, {
"name": "system",
"valueUri": "example"
}, {
"name": "systemVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ValueSet/{id}/$invalidate-expansion:
post:
tags:
- ValueSet
summary: "POST: /ValueSet/{id}/$invalidate-expansion"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ValueSet/$expand:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/$expand"
parameters:
- name: url
in: query
required: false
schema:
type: string
- name: valueSetVersion
in: query
required: false
schema:
type: string
- name: filter
in: query
required: false
schema:
type: string
- name: context
in: query
required: false
schema:
type: string
- name: contextDirection
in: query
required: false
schema:
type: string
- name: offset
in: query
required: false
schema:
type: string
- name: count
in: query
required: false
schema:
type: string
- name: displayLanguage
in: query
required: false
schema:
type: string
- name: includeHierarchy
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- ValueSet
summary: "POST: /ValueSet/$expand"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "valueSet",
"resource": {
"resourceType": "ValueSet",
"id": "1"
}
}, {
"name": "url",
"valueUri": "example"
}, {
"name": "valueSetVersion",
"valueString": "example"
}, {
"name": "filter",
"valueString": "example"
}, {
"name": "context",
"valueString": "example"
}, {
"name": "contextDirection",
"valueString": "example"
}, {
"name": "offset",
"valueInteger": 0
}, {
"name": "count",
"valueInteger": 0
}, {
"name": "displayLanguage",
"valueCode": "example"
}, {
"name": "includeHierarchy",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ValueSet/{id}/$expand:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/{id}/$expand"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: url
in: query
required: false
schema:
type: string
- name: valueSetVersion
in: query
required: false
schema:
type: string
- name: filter
in: query
required: false
schema:
type: string
- name: context
in: query
required: false
schema:
type: string
- name: contextDirection
in: query
required: false
schema:
type: string
- name: offset
in: query
required: false
schema:
type: string
- name: count
in: query
required: false
schema:
type: string
- name: displayLanguage
in: query
required: false
schema:
type: string
- name: includeHierarchy
in: query
required: false
schema:
type: string
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- ValueSet
summary: "POST: /ValueSet/{id}/$expand"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "valueSet",
"resource": {
"resourceType": "ValueSet",
"id": "1"
}
}, {
"name": "url",
"valueUri": "example"
}, {
"name": "valueSetVersion",
"valueString": "example"
}, {
"name": "filter",
"valueString": "example"
}, {
"name": "context",
"valueString": "example"
}, {
"name": "contextDirection",
"valueString": "example"
}, {
"name": "offset",
"valueInteger": 0
}, {
"name": "count",
"valueInteger": 0
}, {
"name": "displayLanguage",
"valueCode": "example"
}, {
"name": "includeHierarchy",
"valueBoolean": false
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/ValueSet/$validate:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/$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:
- ValueSet
summary: "POST: /ValueSet/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "ValueSet",
"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"
/ValueSet/{id}/$validate:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/{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:
- ValueSet
summary: "POST: /ValueSet/{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": "ValueSet",
"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"
/ValueSet/{id}/$meta-delete:
post:
tags:
- ValueSet
summary: "POST: /ValueSet/{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"
/ValueSet/{id}/$meta-add:
post:
tags:
- ValueSet
summary: "POST: /ValueSet/{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"
/ValueSet/$meta:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/$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:
- ValueSet
summary: "POST: /ValueSet/$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"
/ValueSet/{id}/$meta:
get:
tags:
- ValueSet
summary: "GET: /ValueSet/{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:
- ValueSet
summary: "POST: /ValueSet/{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"
/ValueSet/$expunge:
post:
tags:
- ValueSet
summary: "POST: /ValueSet/$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"
/ValueSet/{id}/$expunge:
post:
tags:
- ValueSet
summary: "POST: /ValueSet/{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"
/ValueSet/{id}/$diff:
get:
tags:
- ValueSet
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: from
in: query
description: The resource ID and version to diff from
required: true
schema:
type: string
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
schema:
type: string
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
schema:
type: string
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
schema:
type: string
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- ValueSet
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "from"
}, {
"name": "to"
}, {
"name": "includeMeta",
"valueBoolean": false
}, {
"name": "fromVersion",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/VerificationResult/{id}:
get:
tags:
- VerificationResult
summary: "read-instance: Read VerificationResult instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- VerificationResult
summary: "update-instance: Update an existing VerificationResult instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "VerificationResult"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- VerificationResult
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- VerificationResult
summary: "instance-patch: Patch a resource instance of type VerificationResult\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/VerificationResult/{id}/_history/{version_id}:
get:
tags:
- VerificationResult
summary: "vread-instance: Read VerificationResult instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/VerificationResult:
get:
tags:
- VerificationResult
summary: "search-type: Search for VerificationResult instances"
description: This is a search type
parameters:
- name: _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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: target
in: query
description: A resource that was validated
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
post:
tags:
- VerificationResult
summary: "create-type: Create a new VerificationResult instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "VerificationResult"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/VerificationResult/_history:
get:
tags:
- VerificationResult
summary: "type-history: Fetch the resource change history for all resources\
\ of type VerificationResult"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/VerificationResult/{id}/_history:
get:
tags:
- VerificationResult
summary: "instance-history: Fetch the resource change history for all resources\
\ of type VerificationResult"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/VerificationResult/_search:
get:
tags:
- VerificationResult
summary: "search-type: Search for VerificationResult instances"
description: This is a search type
parameters:
- 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: _lastUpdated
in: query
description: When the resource version last changed
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- 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: _security
in: query
description: Security Labels applied to this resource
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: target
in: query
description: A resource that was validated
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
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/VerificationResult/$validate:
get:
tags:
- VerificationResult
summary: "GET: /VerificationResult/$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:
- VerificationResult
summary: "POST: /VerificationResult/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "VerificationResult",
"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"
/VerificationResult/{id}/$validate:
get:
tags:
- VerificationResult
summary: "GET: /VerificationResult/{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:
- VerificationResult
summary: "POST: /VerificationResult/{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": "VerificationResult",
"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"
/VerificationResult/{id}/$meta-delete:
post:
tags:
- VerificationResult
summary: "POST: /VerificationResult/{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"
/VerificationResult/{id}/$meta-add:
post:
tags:
- VerificationResult
summary: "POST: /VerificationResult/{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"
/VerificationResult/$meta:
get:
tags:
- VerificationResult
summary: "GET: /VerificationResult/$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:
- VerificationResult
summary: "POST: /VerificationResult/$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"
/VerificationResult/{id}/$meta:
get:
tags:
- VerificationResult
summary: "GET: /VerificationResult/{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:
- VerificationResult
summary: "POST: /VerificationResult/{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"
/VerificationResult/$expunge:
post:
tags:
- VerificationResult
summary: "POST: /VerificationResult/$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"
/VerificationResult/{id}/$expunge:
post:
tags:
- VerificationResult
summary: "POST: /VerificationResult/{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"
/VerificationResult/{id}/$diff:
get:
tags:
- VerificationResult
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:
- VerificationResult
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"
/VisionPrescription/{id}:
get:
tags:
- VisionPrescription
summary: "read-instance: Read VisionPrescription instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
put:
tags:
- VisionPrescription
summary: "update-instance: Update an existing VisionPrescription instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "VisionPrescription"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
delete:
tags:
- VisionPrescription
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
patch:
tags:
- VisionPrescription
summary: "instance-patch: Patch a resource instance of type VisionPrescription\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example: |-
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/VisionPrescription/{id}/_history/{version_id}:
get:
tags:
- VisionPrescription
summary: "vread-instance: Read VisionPrescription instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/VisionPrescription:
get:
tags:
- VisionPrescription
summary: "search-type: Search for VisionPrescription instances"
description: This is a search type
parameters:
- name: prescriber
in: query
description: Who authorized the vision prescription
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
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: datewritten
in: query
description: Return prescriptions written on this date
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* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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 vision prescription
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:
- VisionPrescription
summary: "create-type: Create a new VisionPrescription instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
example: |-
{
"resourceType": "VisionPrescription"
}
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
example:
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/VisionPrescription/_history:
get:
tags:
- VisionPrescription
summary: "type-history: Fetch the resource change history for all resources\
\ of type VisionPrescription"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/VisionPrescription/{id}/_history:
get:
tags:
- VisionPrescription
summary: "instance-history: Fetch the resource change history for all resources\
\ of type VisionPrescription"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: "#/components/schemas/FHIR-JSON-RESOURCE"
application/fhir+xml:
schema:
$ref: "#/components/schemas/FHIR-XML-RESOURCE"
/VisionPrescription/_search:
get:
tags:
- VisionPrescription
summary: "search-type: Search for VisionPrescription instances"
description: This is a search type
parameters:
- name: prescriber
in: query
description: Who authorized the vision prescription
required: false
schema:
type: string
- name: identifier
in: query
description: "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html):\
\ External ids for this item\r\n* [CarePlan](careplan.html): External Ids\
\ for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\
\n* [Composition](composition.html): Version-independent identifier for\
\ the Composition\r\n* [Condition](condition.html): A unique identifier\
\ of the condition record\r\n* [Consent](consent.html): Identifier for this\
\ record (external references)\r\n* [DetectedIssue](detectedissue.html):\
\ Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html):\
\ Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html):\
\ An identifier for the report\r\n* [DocumentManifest](documentmanifest.html):\
\ Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s)\
\ by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html):\
\ Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ A search by a record identifier\r\n* [Goal](goal.html): External Ids for\
\ this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the\
\ Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html):\
\ Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html):\
\ Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html):\
\ Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html):\
\ Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html):\
\ Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html):\
\ Return nutrition orders with this external identifier\r\n* [Observation](observation.html):\
\ The unique id for a particular observation\r\n* [Procedure](procedure.html):\
\ A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html):\
\ Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html):\
\ Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html):\
\ External identifier\r\n* [SupplyRequest](supplyrequest.html): Business\
\ Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this external identifier"
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: datewritten
in: query
description: Return prescriptions written on this date
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* [Composition](composition.html):\
\ Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter\
\ during which request was created\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The Encounter when the order was made\r\n* [DocumentReference](documentreference.html):\
\ Context of the document content\r\n* [Flag](flag.html): Alert relevant\
\ during encounter\r\n* [List](list.html): Context in which list created\r\
\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with\
\ this encounter identifier\r\n* [Observation](observation.html): Encounter\
\ related to the observation\r\n* [Procedure](procedure.html): Encounter\
\ created as part of\r\n* [RiskAssessment](riskassessment.html): Where was\
\ assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter\
\ in which this request is made\r\n* [VisionPrescription](visionprescription.html):\
\ Return prescriptions with this encounter identifier"
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* [AllergyIntolerance](allergyintolerance.html):\
\ Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care\
\ plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n*\
\ [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\
\n* [Composition](composition.html): Who and/or what the composition is\
\ about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html):\
\ Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated\
\ patient\r\n* [DeviceRequest](devicerequest.html): Individual the service\
\ is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search\
\ by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html):\
\ The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html):\
\ The subject of the set of documents\r\n* [DocumentReference](documentreference.html):\
\ Who/what is the subject of the document\r\n* [Encounter](encounter.html):\
\ The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html):\
\ The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html):\
\ The identity of a subject to list family member history items for\r\n\
* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html):\
\ Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html):\
\ Who the study is about\r\n* [Immunization](immunization.html): The patient\
\ for the vaccination record\r\n* [List](list.html): If all resources have\
\ the same subject\r\n* [MedicationAdministration](medicationadministration.html):\
\ The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html):\
\ The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html):\
\ Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html):\
\ Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html):\
\ The identity of the person who requires the diet, formula or nutritional\
\ supplement\r\n* [Observation](observation.html): The subject that the\
\ observation is about (if patient)\r\n* [Procedure](procedure.html): Search\
\ by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what\
\ does assessment apply to?\r\n* [ServiceRequest](servicerequest.html):\
\ Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html):\
\ Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html):\
\ The identity of a patient to list dispenses for"
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 vision prescription
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"
/VisionPrescription/$validate:
get:
tags:
- VisionPrescription
summary: "GET: /VisionPrescription/$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:
- VisionPrescription
summary: "POST: /VisionPrescription/$validate"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "VisionPrescription",
"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"
/VisionPrescription/{id}/$validate:
get:
tags:
- VisionPrescription
summary: "GET: /VisionPrescription/{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:
- VisionPrescription
summary: "POST: /VisionPrescription/{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": "VisionPrescription",
"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"
/VisionPrescription/{id}/$meta-delete:
post:
tags:
- VisionPrescription
summary: "POST: /VisionPrescription/{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"
/VisionPrescription/{id}/$meta-add:
post:
tags:
- VisionPrescription
summary: "POST: /VisionPrescription/{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"
/VisionPrescription/$meta:
get:
tags:
- VisionPrescription
summary: "GET: /VisionPrescription/$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:
- VisionPrescription
summary: "POST: /VisionPrescription/$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"
/VisionPrescription/{id}/$meta:
get:
tags:
- VisionPrescription
summary: "GET: /VisionPrescription/{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:
- VisionPrescription
summary: "POST: /VisionPrescription/{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"
/VisionPrescription/$expunge:
post:
tags:
- VisionPrescription
summary: "POST: /VisionPrescription/$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"
/VisionPrescription/{id}/$expunge:
post:
tags:
- VisionPrescription
summary: "POST: /VisionPrescription/{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"
/VisionPrescription/{id}/$diff:
get:
tags:
- VisionPrescription
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:
- VisionPrescription
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"
components:
schemas:
FHIR-JSON-RESOURCE:
type: object
description: A FHIR resource
FHIR-XML-RESOURCE:
type: object
description: A FHIR resource