openapi: 3.0.1 info: title: HAPI FHIR Server contact: {} version: 6.6.0 servers: - url: http://localhost:8080/fhir description: HAPI FHIR Server tags: - name: System Level Operations description: Server-level operations - name: Account description: The Account FHIR resource type - name: ActivityDefinition description: The ActivityDefinition FHIR resource type - name: AdverseEvent description: The AdverseEvent FHIR resource type - name: AllergyIntolerance description: The AllergyIntolerance FHIR resource type - name: Appointment description: The Appointment FHIR resource type - name: AppointmentResponse description: The AppointmentResponse FHIR resource type - name: AuditEvent description: The AuditEvent FHIR resource type - name: Basic description: The Basic FHIR resource type - name: Binary description: The Binary FHIR resource type - name: BiologicallyDerivedProduct description: The BiologicallyDerivedProduct FHIR resource type - name: BodyStructure description: The BodyStructure FHIR resource type - name: Bundle description: The Bundle FHIR resource type - name: CapabilityStatement description: The CapabilityStatement FHIR resource type - name: CarePlan description: The CarePlan FHIR resource type - name: CareTeam description: The CareTeam FHIR resource type - name: CatalogEntry description: The CatalogEntry FHIR resource type - name: ChargeItem description: The ChargeItem FHIR resource type - name: ChargeItemDefinition description: The ChargeItemDefinition FHIR resource type - name: Claim description: The Claim FHIR resource type - name: ClaimResponse description: The ClaimResponse FHIR resource type - name: ClinicalImpression description: The ClinicalImpression FHIR resource type - name: CodeSystem description: The CodeSystem FHIR resource type - name: Communication description: The Communication FHIR resource type - name: CommunicationRequest description: The CommunicationRequest FHIR resource type - name: CompartmentDefinition description: The CompartmentDefinition FHIR resource type - name: Composition description: The Composition FHIR resource type - name: ConceptMap description: The ConceptMap FHIR resource type - name: Condition description: The Condition FHIR resource type - name: Consent description: The Consent FHIR resource type - name: Contract description: The Contract FHIR resource type - name: Coverage description: The Coverage FHIR resource type - name: CoverageEligibilityRequest description: The CoverageEligibilityRequest FHIR resource type - name: CoverageEligibilityResponse description: The CoverageEligibilityResponse FHIR resource type - name: DetectedIssue description: The DetectedIssue FHIR resource type - name: Device description: The Device FHIR resource type - name: DeviceDefinition description: The DeviceDefinition FHIR resource type - name: DeviceMetric description: The DeviceMetric FHIR resource type - name: DeviceRequest description: The DeviceRequest FHIR resource type - name: DeviceUseStatement description: The DeviceUseStatement FHIR resource type - name: DiagnosticReport description: The DiagnosticReport FHIR resource type - name: DocumentManifest description: The DocumentManifest FHIR resource type - name: DocumentReference description: The DocumentReference FHIR resource type - name: EffectEvidenceSynthesis description: The EffectEvidenceSynthesis FHIR resource type - name: Encounter description: The Encounter FHIR resource type - name: Endpoint description: The Endpoint FHIR resource type - name: EnrollmentRequest description: The EnrollmentRequest FHIR resource type - name: EnrollmentResponse description: The EnrollmentResponse FHIR resource type - name: EpisodeOfCare description: The EpisodeOfCare FHIR resource type - name: EventDefinition description: The EventDefinition FHIR resource type - name: Evidence description: The Evidence FHIR resource type - name: EvidenceVariable description: The EvidenceVariable FHIR resource type - name: ExampleScenario description: The ExampleScenario FHIR resource type - name: ExplanationOfBenefit description: The ExplanationOfBenefit FHIR resource type - name: FamilyMemberHistory description: The FamilyMemberHistory FHIR resource type - name: Flag description: The Flag FHIR resource type - name: Goal description: The Goal FHIR resource type - name: GraphDefinition description: The GraphDefinition FHIR resource type - name: Group description: The Group FHIR resource type - name: GuidanceResponse description: The GuidanceResponse FHIR resource type - name: HealthcareService description: The HealthcareService FHIR resource type - name: ImagingStudy description: The ImagingStudy FHIR resource type - name: Immunization description: The Immunization FHIR resource type - name: ImmunizationEvaluation description: The ImmunizationEvaluation FHIR resource type - name: ImmunizationRecommendation description: The ImmunizationRecommendation FHIR resource type - name: ImplementationGuide description: The ImplementationGuide FHIR resource type - name: InsurancePlan description: The InsurancePlan FHIR resource type - name: Invoice description: The Invoice FHIR resource type - name: Library description: The Library FHIR resource type - name: Linkage description: The Linkage FHIR resource type - name: List description: The List FHIR resource type - name: Location description: The Location FHIR resource type - name: Measure description: The Measure FHIR resource type - name: MeasureReport description: The MeasureReport FHIR resource type - name: Media description: The Media FHIR resource type - name: Medication description: The Medication FHIR resource type - name: MedicationAdministration description: The MedicationAdministration FHIR resource type - name: MedicationDispense description: The MedicationDispense FHIR resource type - name: MedicationKnowledge description: The MedicationKnowledge FHIR resource type - name: MedicationRequest description: The MedicationRequest FHIR resource type - name: MedicationStatement description: The MedicationStatement FHIR resource type - name: MedicinalProduct description: The MedicinalProduct FHIR resource type - name: MedicinalProductAuthorization description: The MedicinalProductAuthorization FHIR resource type - name: MedicinalProductContraindication description: The MedicinalProductContraindication FHIR resource type - name: MedicinalProductIndication description: The MedicinalProductIndication FHIR resource type - name: MedicinalProductIngredient description: The MedicinalProductIngredient FHIR resource type - name: MedicinalProductInteraction description: The MedicinalProductInteraction FHIR resource type - name: MedicinalProductManufactured description: The MedicinalProductManufactured FHIR resource type - name: MedicinalProductPackaged description: The MedicinalProductPackaged FHIR resource type - name: MedicinalProductPharmaceutical description: The MedicinalProductPharmaceutical FHIR resource type - name: MedicinalProductUndesirableEffect description: The MedicinalProductUndesirableEffect FHIR resource type - name: MessageDefinition description: The MessageDefinition FHIR resource type - name: MessageHeader description: The MessageHeader FHIR resource type - name: MolecularSequence description: The MolecularSequence FHIR resource type - name: NamingSystem description: The NamingSystem FHIR resource type - name: NutritionOrder description: The NutritionOrder FHIR resource type - name: Observation description: The Observation FHIR resource type - name: ObservationDefinition description: The ObservationDefinition FHIR resource type - name: OperationDefinition description: The OperationDefinition FHIR resource type - name: OperationOutcome description: The OperationOutcome FHIR resource type - name: Organization description: The Organization FHIR resource type - name: OrganizationAffiliation description: The OrganizationAffiliation FHIR resource type - name: Parameters description: The Parameters FHIR resource type - name: Patient description: The Patient FHIR resource type - name: PaymentNotice description: The PaymentNotice FHIR resource type - name: PaymentReconciliation description: The PaymentReconciliation FHIR resource type - name: Person description: The Person FHIR resource type - name: PlanDefinition description: The PlanDefinition FHIR resource type - name: Practitioner description: The Practitioner FHIR resource type - name: PractitionerRole description: The PractitionerRole FHIR resource type - name: Procedure description: The Procedure FHIR resource type - name: Provenance description: The Provenance FHIR resource type - name: Questionnaire description: The Questionnaire FHIR resource type - name: QuestionnaireResponse description: The QuestionnaireResponse FHIR resource type - name: RelatedPerson description: The RelatedPerson FHIR resource type - name: RequestGroup description: The RequestGroup FHIR resource type - name: ResearchDefinition description: The ResearchDefinition FHIR resource type - name: ResearchElementDefinition description: The ResearchElementDefinition FHIR resource type - name: ResearchStudy description: The ResearchStudy FHIR resource type - name: ResearchSubject description: The ResearchSubject FHIR resource type - name: RiskAssessment description: The RiskAssessment FHIR resource type - name: RiskEvidenceSynthesis description: The RiskEvidenceSynthesis FHIR resource type - name: Schedule description: The Schedule FHIR resource type - name: SearchParameter description: The SearchParameter FHIR resource type - name: ServiceRequest description: The ServiceRequest FHIR resource type - name: Slot description: The Slot FHIR resource type - name: Specimen description: The Specimen FHIR resource type - name: SpecimenDefinition description: The SpecimenDefinition FHIR resource type - name: StructureDefinition description: The StructureDefinition FHIR resource type - name: StructureMap description: The StructureMap FHIR resource type - name: Subscription description: The Subscription FHIR resource type - name: Substance description: The Substance FHIR resource type - name: SubstanceNucleicAcid description: The SubstanceNucleicAcid FHIR resource type - name: SubstancePolymer description: The SubstancePolymer FHIR resource type - name: SubstanceProtein description: The SubstanceProtein FHIR resource type - name: SubstanceReferenceInformation description: The SubstanceReferenceInformation FHIR resource type - name: SubstanceSourceMaterial description: The SubstanceSourceMaterial FHIR resource type - name: SubstanceSpecification description: The SubstanceSpecification FHIR resource type - name: SupplyDelivery description: The SupplyDelivery FHIR resource type - name: SupplyRequest description: The SupplyRequest FHIR resource type - name: Task description: The Task FHIR resource type - name: TerminologyCapabilities description: The TerminologyCapabilities FHIR resource type - name: TestReport description: The TestReport FHIR resource type - name: TestScript description: The TestScript FHIR resource type - name: ValueSet description: The ValueSet FHIR resource type - name: VerificationResult description: The VerificationResult FHIR resource type - name: VisionPrescription description: The VisionPrescription FHIR resource type 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /_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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$reindex: post: tags: - System Level Operations requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$perform-reindexing-pass: post: tags: - System Level Operations description: Forces a single pass of the resource reindexing processor requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$meta: get: tags: - System Level Operations 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - System Level Operations 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$mark-all-resources-for-reindexing: post: tags: - System Level Operations 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: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "type", "valueCode": "example" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$expunge: post: tags: - System Level Operations requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /$reindex-terminology: post: tags: - System Level Operations requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: Account number style: simple - name: period in: query description: Transaction window style: simple - name: subject in: query description: The entity that caused the expenses style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: "E.g. patient, expense, depreciation" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The entity that caused the expenses style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Human-readable label style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: active | inactive | entered-in-error | on-hold | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: Account number style: simple - name: period in: query description: Transaction window style: simple - name: subject in: query description: The entity that caused the expenses style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: "E.g. patient, expense, depreciation" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The entity that caused the expenses style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Human-readable label style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: active | inactive | entered-in-error | on-hold | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Account/$validate: get: tags: - Account parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Account requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Account/{id}/$validate: get: tags: - Account parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Account parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Account/{id}/$meta-delete: post: tags: - Account description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Account/{id}/$meta-add: post: tags: - Account description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Account/$meta: get: tags: - Account 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Account 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Account/{id}/$meta: get: tags: - Account description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Account description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Account/$expunge: post: tags: - Account requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Account/{id}/$expunge: post: tags: - Account parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the activity definition style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the activity definition style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the activity definition style: simple - name: context-type in: query description: A type of use context assigned to the activity definition style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the activity definition style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the activity definition style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the activity definition is intended to be in use style: simple - name: context in: query description: A use context assigned to the activity definition style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the activity definition style: simple - name: identifier in: query description: External identifier for the activity definition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the activity definition style: simple - name: url in: query description: The uri that identifies the activity definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the activity definition style: simple - name: publisher in: query description: Name of the publisher of the activity definition style: simple - name: topic in: query description: Topics associated with the module style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the activity definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the activity definition style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the activity definition style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the activity definition style: simple - name: context-type in: query description: A type of use context assigned to the activity definition style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the activity definition style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the activity definition style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the activity definition is intended to be in use style: simple - name: context in: query description: A use context assigned to the activity definition style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the activity definition style: simple - name: identifier in: query description: External identifier for the activity definition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the activity definition style: simple - name: url in: query description: The uri that identifies the activity definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the activity definition style: simple - name: publisher in: query description: Name of the publisher of the activity definition style: simple - name: topic in: query description: Topics associated with the module style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the activity definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ActivityDefinition/$validate: get: tags: - ActivityDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ActivityDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ActivityDefinition/{id}/$validate: get: tags: - ActivityDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ActivityDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ActivityDefinition/{id}/$meta-delete: post: tags: - ActivityDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ActivityDefinition/{id}/$meta-add: post: tags: - ActivityDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ActivityDefinition/$meta: get: tags: - ActivityDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ActivityDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ActivityDefinition/{id}/$meta: get: tags: - ActivityDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ActivityDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ActivityDefinition/$expunge: post: tags: - ActivityDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ActivityDefinition/{id}/$expunge: post: tags: - ActivityDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: severity in: query description: mild | moderate | severe style: simple - name: recorder in: query description: Who recorded the adverse event style: simple - name: study in: query description: AdverseEvent.study style: simple - name: actuality in: query description: actual | potential style: simple - name: subject in: query description: Subject impacted by event style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: resultingcondition in: query description: Effect on the subject due to this event style: simple - name: substance in: query description: Refers to the specific entity that caused the adverse event style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: seriousness in: query description: Seriousness of the event style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: Location where adverse event occurred style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: 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 style: simple - name: event in: query description: Type of the event itself in relation to the subject style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: severity in: query description: mild | moderate | severe style: simple - name: recorder in: query description: Who recorded the adverse event style: simple - name: study in: query description: AdverseEvent.study style: simple - name: actuality in: query description: actual | potential style: simple - name: subject in: query description: Subject impacted by event style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: resultingcondition in: query description: Effect on the subject due to this event style: simple - name: substance in: query description: Refers to the specific entity that caused the adverse event style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: seriousness in: query description: Seriousness of the event style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: Location where adverse event occurred style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: 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 style: simple - name: event in: query description: Type of the event itself in relation to the subject style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AdverseEvent/$validate: get: tags: - AdverseEvent parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AdverseEvent requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AdverseEvent/{id}/$validate: get: tags: - AdverseEvent parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AdverseEvent parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AdverseEvent/{id}/$meta-delete: post: tags: - AdverseEvent description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AdverseEvent/{id}/$meta-add: post: tags: - AdverseEvent description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AdverseEvent/$meta: get: tags: - AdverseEvent 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AdverseEvent 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AdverseEvent/{id}/$meta: get: tags: - AdverseEvent description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AdverseEvent description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AdverseEvent/$expunge: post: tags: - AdverseEvent requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AdverseEvent/{id}/$expunge: post: tags: - AdverseEvent parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: verification-status in: query description: unconfirmed | confirmed | refuted | entered-in-error style: simple - name: criticality in: query description: low | high | unable-to-assess style: simple - name: clinical-status in: query description: active | inactive | resolved style: simple - 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" style: simple - 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" style: simple - name: severity in: query description: mild | moderate | severe (of event as a whole) style: simple - 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" style: simple - name: manifestation in: query description: Clinical symptoms/signs associated with the Event style: simple - name: recorder in: query description: Who recorded the sensitivity style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: onset in: query description: Date(/time) when manifestations showed style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: asserter in: query description: Source of the information about the allergy style: simple - name: route in: query description: How the subject was exposed to the substance style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: food | medication | environment | biologic style: simple - name: last-date in: query description: Date(/time) of last known occurrence of a reaction style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: verification-status in: query description: unconfirmed | confirmed | refuted | entered-in-error style: simple - name: criticality in: query description: low | high | unable-to-assess style: simple - name: clinical-status in: query description: active | inactive | resolved style: simple - 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" style: simple - 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" style: simple - name: severity in: query description: mild | moderate | severe (of event as a whole) style: simple - 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" style: simple - name: manifestation in: query description: Clinical symptoms/signs associated with the Event style: simple - name: recorder in: query description: Who recorded the sensitivity style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: onset in: query description: Date(/time) when manifestations showed style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: asserter in: query description: Source of the information about the allergy style: simple - name: route in: query description: How the subject was exposed to the substance style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: food | medication | environment | biologic style: simple - name: last-date in: query description: Date(/time) of last known occurrence of a reaction style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AllergyIntolerance/$validate: get: tags: - AllergyIntolerance parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AllergyIntolerance requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AllergyIntolerance/{id}/$validate: get: tags: - AllergyIntolerance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AllergyIntolerance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AllergyIntolerance/{id}/$meta-delete: post: tags: - AllergyIntolerance description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AllergyIntolerance/{id}/$meta-add: post: tags: - AllergyIntolerance description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AllergyIntolerance/$meta: get: tags: - AllergyIntolerance 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AllergyIntolerance 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AllergyIntolerance/{id}/$meta: get: tags: - AllergyIntolerance description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AllergyIntolerance description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AllergyIntolerance/$expunge: post: tags: - AllergyIntolerance requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AllergyIntolerance/{id}/$expunge: post: tags: - AllergyIntolerance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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. style: simple - name: specialty in: query description: The specialty of a practitioner that would be required to perform the service requested in this appointment style: simple - name: service-category in: query description: A broad categorization of the service that is to be performed during this appointment style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: slot in: query description: The slots that this appointment is filling style: simple - name: reason-code in: query description: Coded reason this appointment is scheduled style: simple - name: based-on in: query description: The service request this appointment is allocated to assess style: simple - name: patient in: query description: One of the individuals of the appointment is this patient style: simple - name: supporting-info in: query description: Additional information to support the appointment style: simple - name: identifier in: query description: An Identifier of the Appointment style: simple - name: practitioner in: query description: One of the individuals of the appointment is this practitioner style: simple - name: appointment-type in: query description: The style of appointment or patient that has been booked in the slot (not service type) style: simple - 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." style: simple - name: service-type in: query description: The specific service that is to be performed during this appointment style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: actor in: query description: Any one of the individuals participating in the appointment style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: reason-reference in: query description: Reason the appointment is to take place (resource) style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: This location is listed in the participants of the appointment style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The overall status of the appointment style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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. style: simple - name: specialty in: query description: The specialty of a practitioner that would be required to perform the service requested in this appointment style: simple - name: service-category in: query description: A broad categorization of the service that is to be performed during this appointment style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: slot in: query description: The slots that this appointment is filling style: simple - name: reason-code in: query description: Coded reason this appointment is scheduled style: simple - name: based-on in: query description: The service request this appointment is allocated to assess style: simple - name: patient in: query description: One of the individuals of the appointment is this patient style: simple - name: supporting-info in: query description: Additional information to support the appointment style: simple - name: identifier in: query description: An Identifier of the Appointment style: simple - name: practitioner in: query description: One of the individuals of the appointment is this practitioner style: simple - name: appointment-type in: query description: The style of appointment or patient that has been booked in the slot (not service type) style: simple - 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." style: simple - name: service-type in: query description: The specific service that is to be performed during this appointment style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: actor in: query description: Any one of the individuals participating in the appointment style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: reason-reference in: query description: Reason the appointment is to take place (resource) style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: This location is listed in the participants of the appointment style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The overall status of the appointment style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Appointment/$validate: get: tags: - Appointment parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Appointment requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Appointment/{id}/$validate: get: tags: - Appointment parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Appointment parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Appointment/{id}/$meta-delete: post: tags: - Appointment description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Appointment/{id}/$meta-add: post: tags: - Appointment description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Appointment/$meta: get: tags: - Appointment 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Appointment 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Appointment/{id}/$meta: get: tags: - Appointment description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Appointment description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Appointment/$expunge: post: tags: - Appointment requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Appointment/{id}/$expunge: post: tags: - Appointment parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: practitioner in: query description: This Response is for this Practitioner style: simple - name: part-status in: query description: The participants acceptance status for this appointment style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: appointment in: query description: The appointment that the response is attached to style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: actor in: query description: "The Person, Location/HealthcareService or Device that this appointment\ \ response replies for" style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: This Response is for this Patient style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: This Response is for this Location style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: practitioner in: query description: This Response is for this Practitioner style: simple - name: part-status in: query description: The participants acceptance status for this appointment style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: appointment in: query description: The appointment that the response is attached to style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: actor in: query description: "The Person, Location/HealthcareService or Device that this appointment\ \ response replies for" style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: This Response is for this Patient style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: This Response is for this Location style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AppointmentResponse/$validate: get: tags: - AppointmentResponse parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AppointmentResponse requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AppointmentResponse/{id}/$validate: get: tags: - AppointmentResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AppointmentResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AppointmentResponse/{id}/$meta-delete: post: tags: - AppointmentResponse description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AppointmentResponse/{id}/$meta-add: post: tags: - AppointmentResponse description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AppointmentResponse/$meta: get: tags: - AppointmentResponse 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AppointmentResponse 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AppointmentResponse/{id}/$meta: get: tags: - AppointmentResponse description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AppointmentResponse description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AppointmentResponse/$expunge: post: tags: - AppointmentResponse requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AppointmentResponse/{id}/$expunge: post: tags: - AppointmentResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: entity-type in: query description: Type of entity involved style: simple - name: agent in: query description: Identifier of who style: simple - name: entity-role in: query description: What role the entity played style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: source in: query description: The identity of source detecting the event style: simple - name: type in: query description: Type/identifier of event style: simple - name: altid in: query description: Alternative User identity style: simple - name: agent-name in: query description: Human friendly name for the agent style: simple - name: entity-name in: query description: Descriptor for entity style: simple - name: subtype in: query description: More specific type/id for the event style: simple - name: patient in: query description: Identifier of who style: simple - name: action in: query description: Type of action performed during the event style: simple - name: outcome in: query description: Whether the event succeeded or failed style: simple - name: policy in: query description: Policy that authorized event style: simple - name: address in: query description: Identifier for the network access point of the user device style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: site in: query description: Logical source location within the enterprise style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: agent-role in: query description: Agent role in the event style: simple - name: entity in: query description: Specific instance of resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: entity-type in: query description: Type of entity involved style: simple - name: agent in: query description: Identifier of who style: simple - name: entity-role in: query description: What role the entity played style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: source in: query description: The identity of source detecting the event style: simple - name: type in: query description: Type/identifier of event style: simple - name: altid in: query description: Alternative User identity style: simple - name: agent-name in: query description: Human friendly name for the agent style: simple - name: entity-name in: query description: Descriptor for entity style: simple - name: subtype in: query description: More specific type/id for the event style: simple - name: patient in: query description: Identifier of who style: simple - name: action in: query description: Type of action performed during the event style: simple - name: outcome in: query description: Whether the event succeeded or failed style: simple - name: policy in: query description: Policy that authorized event style: simple - name: address in: query description: Identifier for the network access point of the user device style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: site in: query description: Logical source location within the enterprise style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: agent-role in: query description: Agent role in the event style: simple - name: entity in: query description: Specific instance of resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AuditEvent/$validate: get: tags: - AuditEvent parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AuditEvent requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AuditEvent/{id}/$validate: get: tags: - AuditEvent parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AuditEvent parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AuditEvent/{id}/$meta-delete: post: tags: - AuditEvent description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AuditEvent/{id}/$meta-add: post: tags: - AuditEvent description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AuditEvent/$meta: get: tags: - AuditEvent 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AuditEvent 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AuditEvent/{id}/$meta: get: tags: - AuditEvent description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - AuditEvent description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AuditEvent/$expunge: post: tags: - AuditEvent requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /AuditEvent/{id}/$expunge: post: tags: - AuditEvent parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: code in: query description: Kind of Resource style: simple - name: author in: query description: Who created style: simple - name: created in: query description: When created style: simple - name: subject in: query description: Identifies the focus of this resource style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: Identifies the focus of this resource style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: code in: query description: Kind of Resource style: simple - name: author in: query description: Who created style: simple - name: created in: query description: When created style: simple - name: subject in: query description: Identifies the focus of this resource style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: Identifies the focus of this resource style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Basic/$validate: get: tags: - Basic parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Basic requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Basic/{id}/$validate: get: tags: - Basic parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Basic parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Basic/{id}/$meta-delete: post: tags: - Basic description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Basic/{id}/$meta-add: post: tags: - Basic description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Basic/$meta: get: tags: - Basic 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Basic 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Basic/{id}/$meta: get: tags: - Basic description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Basic description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Basic/$expunge: post: tags: - Basic requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Basic/{id}/$expunge: post: tags: - Basic parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Binary: get: tags: - Binary summary: "search-type: Search for Binary instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Binary/_search: get: tags: - Binary summary: "search-type: Search for Binary instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Binary/$validate: get: tags: - Binary parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Binary requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Binary/{id}/$validate: get: tags: - Binary parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Binary parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Binary/{id}/$meta-delete: post: tags: - Binary description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Binary/{id}/$meta-add: post: tags: - Binary description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Binary/$meta: get: tags: - Binary 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Binary 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Binary/{id}/$meta: get: tags: - Binary description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Binary description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Binary/$expunge: post: tags: - Binary requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Binary/{id}/$expunge: post: tags: - Binary parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BiologicallyDerivedProduct: get: tags: - BiologicallyDerivedProduct summary: "search-type: Search for BiologicallyDerivedProduct instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BiologicallyDerivedProduct/_search: get: tags: - BiologicallyDerivedProduct summary: "search-type: Search for BiologicallyDerivedProduct instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BiologicallyDerivedProduct/$validate: get: tags: - BiologicallyDerivedProduct parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - BiologicallyDerivedProduct requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BiologicallyDerivedProduct/{id}/$validate: get: tags: - BiologicallyDerivedProduct parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - BiologicallyDerivedProduct parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BiologicallyDerivedProduct/{id}/$meta-delete: post: tags: - BiologicallyDerivedProduct description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BiologicallyDerivedProduct/{id}/$meta-add: post: tags: - BiologicallyDerivedProduct description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BiologicallyDerivedProduct/$meta: get: tags: - BiologicallyDerivedProduct 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - BiologicallyDerivedProduct 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BiologicallyDerivedProduct/{id}/$meta: get: tags: - BiologicallyDerivedProduct description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - BiologicallyDerivedProduct description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BiologicallyDerivedProduct/$expunge: post: tags: - BiologicallyDerivedProduct requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BiologicallyDerivedProduct/{id}/$expunge: post: tags: - BiologicallyDerivedProduct parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: morphology in: query description: Kind of Structure style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: Who this is about style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: Body site style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: morphology in: query description: Kind of Structure style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: Who this is about style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: Body site style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BodyStructure/$validate: get: tags: - BodyStructure parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - BodyStructure requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BodyStructure/{id}/$validate: get: tags: - BodyStructure parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - BodyStructure parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BodyStructure/{id}/$meta-delete: post: tags: - BodyStructure description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BodyStructure/{id}/$meta-add: post: tags: - BodyStructure description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BodyStructure/$meta: get: tags: - BodyStructure 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - BodyStructure 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BodyStructure/{id}/$meta: get: tags: - BodyStructure description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - BodyStructure description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BodyStructure/$expunge: post: tags: - BodyStructure requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /BodyStructure/{id}/$expunge: post: tags: - BodyStructure parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: 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" style: simple - name: type in: query description: document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: 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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: timestamp in: query description: When the bundle was assembled style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: 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" style: simple - name: type in: query description: document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: 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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: timestamp in: query description: When the bundle was assembled style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Bundle/$validate: get: tags: - Bundle parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Bundle requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Bundle/{id}/$validate: get: tags: - Bundle parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Bundle parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Bundle/{id}/$meta-delete: post: tags: - Bundle description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Bundle/{id}/$meta-add: post: tags: - Bundle description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Bundle/$meta: get: tags: - Bundle 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Bundle 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Bundle/{id}/$meta: get: tags: - Bundle description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Bundle description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Bundle/$expunge: post: tags: - Bundle requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Bundle/{id}/$expunge: post: tags: - Bundle parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: software in: query description: Part of the name of a software application style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: fhirversion in: query description: The version of FHIR style: simple - 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" style: simple - name: mode in: query description: Mode - restful (server/client) or messaging (sender/receiver) style: simple - 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" style: simple - 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" style: simple - name: guide in: query description: Implementation guides supported style: simple - 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" style: simple - name: resource-profile in: query description: A profile id invoked in a capability statement style: simple - name: resource in: query description: Name of a resource mentioned in a capability statement style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: format in: query description: formats supported (xml | json | ttl | mime type) style: simple - 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" style: simple - name: supported-profile in: query description: Profiles for use cases supported style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: security-service in: query description: OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - 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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: software in: query description: Part of the name of a software application style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: fhirversion in: query description: The version of FHIR style: simple - 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" style: simple - name: mode in: query description: Mode - restful (server/client) or messaging (sender/receiver) style: simple - 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" style: simple - 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" style: simple - name: guide in: query description: Implementation guides supported style: simple - 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" style: simple - name: resource-profile in: query description: A profile id invoked in a capability statement style: simple - name: resource in: query description: Name of a resource mentioned in a capability statement style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: format in: query description: formats supported (xml | json | ttl | mime type) style: simple - 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" style: simple - name: supported-profile in: query description: Profiles for use cases supported style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: security-service in: query description: OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - 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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CapabilityStatement/$validate: get: tags: - CapabilityStatement parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CapabilityStatement requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CapabilityStatement/{id}/$validate: get: tags: - CapabilityStatement parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CapabilityStatement parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CapabilityStatement/{id}/$meta-delete: post: tags: - CapabilityStatement description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CapabilityStatement/{id}/$meta-add: post: tags: - CapabilityStatement description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CapabilityStatement/$meta: get: tags: - CapabilityStatement 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CapabilityStatement 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CapabilityStatement/{id}/$meta: get: tags: - CapabilityStatement description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CapabilityStatement description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CapabilityStatement/$expunge: post: tags: - CapabilityStatement requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CapabilityStatement/{id}/$expunge: post: tags: - CapabilityStatement parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: care-team in: query description: Who's involved in plan? style: simple - name: subject in: query description: Who the care plan is for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: part-of in: query description: Part of referenced CarePlan style: simple - name: based-on in: query description: Fulfills CarePlan style: simple - 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" style: simple - name: activity-date in: query description: "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]" style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - name: activity-code in: query description: Detail type of activity style: simple - 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" style: simple - name: goal in: query description: Desired outcome of plan style: simple - 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.)" style: simple - name: replaces in: query description: CarePlan replaced by this CarePlan style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: intent in: query description: proposal | plan | order | option style: simple - name: activity-reference in: query description: Activity details defined in specific resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: condition in: query description: Health issues this plan addresses style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Type of plan style: simple - name: status in: query description: draft | active | on-hold | revoked | completed | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: care-team in: query description: Who's involved in plan? style: simple - name: subject in: query description: Who the care plan is for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: part-of in: query description: Part of referenced CarePlan style: simple - name: based-on in: query description: Fulfills CarePlan style: simple - 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" style: simple - name: activity-date in: query description: "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]" style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - name: activity-code in: query description: Detail type of activity style: simple - 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" style: simple - name: goal in: query description: Desired outcome of plan style: simple - 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.)" style: simple - name: replaces in: query description: CarePlan replaced by this CarePlan style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: intent in: query description: proposal | plan | order | option style: simple - name: activity-reference in: query description: Activity details defined in specific resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: condition in: query description: Health issues this plan addresses style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Type of plan style: simple - name: status in: query description: draft | active | on-hold | revoked | completed | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CarePlan/$validate: get: tags: - CarePlan parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CarePlan requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CarePlan/{id}/$validate: get: tags: - CarePlan parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CarePlan parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CarePlan/{id}/$meta-delete: post: tags: - CarePlan description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CarePlan/{id}/$meta-add: post: tags: - CarePlan description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CarePlan/$meta: get: tags: - CarePlan 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CarePlan 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CarePlan/{id}/$meta: get: tags: - CarePlan description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CarePlan description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CarePlan/$expunge: post: tags: - CarePlan requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CarePlan/{id}/$expunge: post: tags: - CarePlan parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: subject in: query description: Who care team is for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: participant in: query description: Who is involved style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Type of team style: simple - name: status in: query description: proposed | active | suspended | inactive | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: subject in: query description: Who care team is for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: participant in: query description: Who is involved style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Type of team style: simple - name: status in: query description: proposed | active | suspended | inactive | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CareTeam/$validate: get: tags: - CareTeam parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CareTeam requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CareTeam/{id}/$validate: get: tags: - CareTeam parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CareTeam parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CareTeam/{id}/$meta-delete: post: tags: - CareTeam description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CareTeam/{id}/$meta-add: post: tags: - CareTeam description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CareTeam/$meta: get: tags: - CareTeam 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CareTeam 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CareTeam/{id}/$meta: get: tags: - CareTeam description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CareTeam description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CareTeam/$expunge: post: tags: - CareTeam requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CareTeam/{id}/$expunge: post: tags: - CareTeam parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CatalogEntry: get: tags: - CatalogEntry summary: "search-type: Search for CatalogEntry instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CatalogEntry/_search: get: tags: - CatalogEntry summary: "search-type: Search for CatalogEntry instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CatalogEntry/$validate: get: tags: - CatalogEntry parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CatalogEntry requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CatalogEntry/{id}/$validate: get: tags: - CatalogEntry parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CatalogEntry parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CatalogEntry/{id}/$meta-delete: post: tags: - CatalogEntry description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CatalogEntry/{id}/$meta-add: post: tags: - CatalogEntry description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CatalogEntry/$meta: get: tags: - CatalogEntry 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CatalogEntry 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CatalogEntry/{id}/$meta: get: tags: - CatalogEntry description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CatalogEntry description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CatalogEntry/$expunge: post: tags: - CatalogEntry requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CatalogEntry/{id}/$expunge: post: tags: - CatalogEntry parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: code in: query description: "A code that identifies the charge, like a billing code" style: simple - name: subject in: query description: Individual service was done for/to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: occurrence in: query description: When the charged service was applied style: simple - name: entered-date in: query description: Date the charge item was entered style: simple - name: performer-function in: query description: What type of performance was done style: simple - name: factor-override in: query description: Factor overriding the associated rules style: simple - name: patient in: query description: Individual service was done for/to style: simple - name: price-override in: query description: Price overriding the associated rules style: simple - name: context in: query description: Encounter / Episode associated with event style: simple - name: enterer in: query description: Individual who was entering style: simple - name: identifier in: query description: Business Identifier for item style: simple - name: quantity in: query description: Quantity of which the charge item has been serviced style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: service in: query description: Which rendered service is being charged? style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: performer-actor in: query description: Individual who was performing style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: account in: query description: Account to place this charge style: simple - name: requesting-organization in: query description: Organization requesting the charged service style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: code in: query description: "A code that identifies the charge, like a billing code" style: simple - name: subject in: query description: Individual service was done for/to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: occurrence in: query description: When the charged service was applied style: simple - name: entered-date in: query description: Date the charge item was entered style: simple - name: performer-function in: query description: What type of performance was done style: simple - name: factor-override in: query description: Factor overriding the associated rules style: simple - name: patient in: query description: Individual service was done for/to style: simple - name: price-override in: query description: Price overriding the associated rules style: simple - name: context in: query description: Encounter / Episode associated with event style: simple - name: enterer in: query description: Individual who was entering style: simple - name: identifier in: query description: Business Identifier for item style: simple - name: quantity in: query description: Quantity of which the charge item has been serviced style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: service in: query description: Which rendered service is being charged? style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: performer-actor in: query description: Individual who was performing style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: account in: query description: Account to place this charge style: simple - name: requesting-organization in: query description: Organization requesting the charged service style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItem/$validate: get: tags: - ChargeItem parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ChargeItem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItem/{id}/$validate: get: tags: - ChargeItem parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ChargeItem parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItem/{id}/$meta-delete: post: tags: - ChargeItem description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItem/{id}/$meta-add: post: tags: - ChargeItem description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItem/$meta: get: tags: - ChargeItem 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ChargeItem 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItem/{id}/$meta: get: tags: - ChargeItem description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ChargeItem description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItem/$expunge: post: tags: - ChargeItem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItem/{id}/$expunge: post: tags: - ChargeItem parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: context-type-value in: query description: A use context type and value assigned to the charge item definition style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the charge item definition style: simple - name: description in: query description: The description of the charge item definition style: simple - name: context-type in: query description: A type of use context assigned to the charge item definition style: simple - name: title in: query description: The human-friendly name of the charge item definition style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the charge item definition style: simple - name: effective in: query description: The time during which the charge item definition is intended to be in use style: simple - name: context in: query description: A use context assigned to the charge item definition style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the charge item definition style: simple - name: identifier in: query description: External identifier for the charge item definition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the charge item definition style: simple - name: url in: query description: The uri that identifies the charge item definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: publisher in: query description: Name of the publisher of the charge item definition style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the charge item definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: context-type-value in: query description: A use context type and value assigned to the charge item definition style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the charge item definition style: simple - name: description in: query description: The description of the charge item definition style: simple - name: context-type in: query description: A type of use context assigned to the charge item definition style: simple - name: title in: query description: The human-friendly name of the charge item definition style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the charge item definition style: simple - name: effective in: query description: The time during which the charge item definition is intended to be in use style: simple - name: context in: query description: A use context assigned to the charge item definition style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the charge item definition style: simple - name: identifier in: query description: External identifier for the charge item definition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the charge item definition style: simple - name: url in: query description: The uri that identifies the charge item definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: publisher in: query description: Name of the publisher of the charge item definition style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the charge item definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItemDefinition/$validate: get: tags: - ChargeItemDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ChargeItemDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItemDefinition/{id}/$validate: get: tags: - ChargeItemDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ChargeItemDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItemDefinition/{id}/$meta-delete: post: tags: - ChargeItemDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItemDefinition/{id}/$meta-add: post: tags: - ChargeItemDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItemDefinition/$meta: get: tags: - ChargeItemDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ChargeItemDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItemDefinition/{id}/$meta: get: tags: - ChargeItemDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ChargeItemDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItemDefinition/$expunge: post: tags: - ChargeItemDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ChargeItemDefinition/{id}/$expunge: post: tags: - ChargeItemDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: use in: query description: The kind of financial resource style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: payee in: query description: The party receiving any payment for the Claim style: simple - name: provider in: query description: Provider responsible for the Claim style: simple - name: insurer in: query description: The target payor/insurer for the Claim style: simple - name: patient in: query description: Patient receiving the products or services style: simple - name: detail-udi in: query description: "UDI associated with a line item, detail product or service" style: simple - name: enterer in: query description: The party responsible for the entry of the Claim style: simple - name: procedure-udi in: query description: UDI associated with a procedure style: simple - name: item-udi in: query description: UDI associated with a line item product or service style: simple - name: identifier in: query description: The primary identifier of the financial resource style: simple - name: created in: query description: The creation date for the Claim style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounters associated with a billed line item style: simple - name: priority in: query description: Processing priority requested style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: subdetail-udi in: query description: "UDI associated with a line item, detail, subdetail product or\ \ service" style: simple - name: facility in: query description: Facility where the products or services have been or will be provided style: simple - name: status in: query description: The status of the Claim instance. style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: use in: query description: The kind of financial resource style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: payee in: query description: The party receiving any payment for the Claim style: simple - name: provider in: query description: Provider responsible for the Claim style: simple - name: insurer in: query description: The target payor/insurer for the Claim style: simple - name: patient in: query description: Patient receiving the products or services style: simple - name: detail-udi in: query description: "UDI associated with a line item, detail product or service" style: simple - name: enterer in: query description: The party responsible for the entry of the Claim style: simple - name: procedure-udi in: query description: UDI associated with a procedure style: simple - name: item-udi in: query description: UDI associated with a line item product or service style: simple - name: identifier in: query description: The primary identifier of the financial resource style: simple - name: created in: query description: The creation date for the Claim style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounters associated with a billed line item style: simple - name: priority in: query description: Processing priority requested style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: subdetail-udi in: query description: "UDI associated with a line item, detail, subdetail product or\ \ service" style: simple - name: facility in: query description: Facility where the products or services have been or will be provided style: simple - name: status in: query description: The status of the Claim instance. style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Claim/$validate: get: tags: - Claim parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Claim requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Claim/{id}/$validate: get: tags: - Claim parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Claim parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Claim/{id}/$meta-delete: post: tags: - Claim description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Claim/{id}/$meta-add: post: tags: - Claim description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Claim/$meta: get: tags: - Claim 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Claim 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Claim/{id}/$meta: get: tags: - Claim description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Claim description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Claim/$expunge: post: tags: - Claim requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Claim/{id}/$expunge: post: tags: - Claim parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: request in: query description: The claim reference style: simple - name: created in: query description: The creation date style: simple - name: use in: query description: The type of claim style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: payment-date in: query description: The expected payment date style: simple - name: requestor in: query description: The Provider of the claim style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: disposition in: query description: The contents of the disposition message style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: insurer in: query description: The organization which generated this resource style: simple - name: patient in: query description: The subject of care style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: outcome in: query description: The processing outcome style: simple - name: status in: query description: The status of the ClaimResponse style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: request in: query description: The claim reference style: simple - name: created in: query description: The creation date style: simple - name: use in: query description: The type of claim style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: payment-date in: query description: The expected payment date style: simple - name: requestor in: query description: The Provider of the claim style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: disposition in: query description: The contents of the disposition message style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: insurer in: query description: The organization which generated this resource style: simple - name: patient in: query description: The subject of care style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: outcome in: query description: The processing outcome style: simple - name: status in: query description: The status of the ClaimResponse style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClaimResponse/$validate: get: tags: - ClaimResponse parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ClaimResponse requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClaimResponse/{id}/$validate: get: tags: - ClaimResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ClaimResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClaimResponse/{id}/$meta-delete: post: tags: - ClaimResponse description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClaimResponse/{id}/$meta-add: post: tags: - ClaimResponse description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClaimResponse/$meta: get: tags: - ClaimResponse 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ClaimResponse 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClaimResponse/{id}/$meta: get: tags: - ClaimResponse description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ClaimResponse description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClaimResponse/$expunge: post: tags: - ClaimResponse requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClaimResponse/{id}/$expunge: post: tags: - ClaimResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: identifier in: query description: Business identifier style: simple - name: previous in: query description: Reference to last assessment style: simple - name: finding-code in: query description: What was found style: simple - name: assessor in: query description: The clinician performing the assessment style: simple - name: subject in: query description: Patient or group assessed style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: finding-ref in: query description: What was found style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: problem in: query description: Relevant impressions of patient state style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - 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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: supporting-info in: query description: Information supporting the clinical impression style: simple - name: investigation in: query description: Record of a specific investigation style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: in-progress | completed | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: identifier in: query description: Business identifier style: simple - name: previous in: query description: Reference to last assessment style: simple - name: finding-code in: query description: What was found style: simple - name: assessor in: query description: The clinician performing the assessment style: simple - name: subject in: query description: Patient or group assessed style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: finding-ref in: query description: What was found style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: problem in: query description: Relevant impressions of patient state style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - 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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: supporting-info in: query description: Information supporting the clinical impression style: simple - name: investigation in: query description: Record of a specific investigation style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: in-progress | completed | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClinicalImpression/$validate: get: tags: - ClinicalImpression parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ClinicalImpression requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClinicalImpression/{id}/$validate: get: tags: - ClinicalImpression parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ClinicalImpression parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClinicalImpression/{id}/$meta-delete: post: tags: - ClinicalImpression description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClinicalImpression/{id}/$meta-add: post: tags: - ClinicalImpression description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClinicalImpression/$meta: get: tags: - ClinicalImpression 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ClinicalImpression 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClinicalImpression/{id}/$meta: get: tags: - ClinicalImpression description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ClinicalImpression description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClinicalImpression/$expunge: post: tags: - ClinicalImpression requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ClinicalImpression/{id}/$expunge: post: tags: - ClinicalImpression parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: code in: query description: A code defined in the code system style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: language in: query description: A language in which a designation is provided style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [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" style: simple - name: content-mode in: query description: not-present | example | fragment | complete | supplement style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: supplements in: query description: Find code system supplements for the referenced code system style: simple - name: system in: query description: The system for any codes defined by this code system (same as 'url') style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: code in: query description: A code defined in the code system style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: language in: query description: A language in which a designation is provided style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [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" style: simple - name: content-mode in: query description: not-present | example | fragment | complete | supplement style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: supplements in: query description: Find code system supplements for the referenced code system style: simple - name: system in: query description: The system for any codes defined by this code system (same as 'url') style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/$upload-external-code-system: post: tags: - CodeSystem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/$apply-codesystem-delta-remove: post: tags: - CodeSystem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/$apply-codesystem-delta-add: post: tags: - CodeSystem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/$validate: get: tags: - CodeSystem parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CodeSystem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/{id}/$validate: get: tags: - CodeSystem parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CodeSystem parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/{id}/$meta-delete: post: tags: - CodeSystem description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/{id}/$meta-add: post: tags: - CodeSystem description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/$meta: get: tags: - CodeSystem 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CodeSystem 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/{id}/$meta: get: tags: - CodeSystem description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CodeSystem description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/$expunge: post: tags: - CodeSystem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/{id}/$expunge: post: tags: - CodeSystem parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/$validate-code: get: tags: - CodeSystem parameters: - name: url in: query required: false style: simple - name: version in: query required: false style: simple - name: code in: query required: false style: simple - name: display in: query required: false style: simple - name: coding in: query required: false style: simple - name: valueSetVersion in: query required: false style: simple - name: system in: query required: false style: simple - name: systemVersion in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CodeSystem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/{id}/$validate-code: get: tags: - CodeSystem parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: url in: query required: false style: simple - name: version in: query required: false style: simple - name: code in: query required: false style: simple - name: display in: query required: false style: simple - name: coding in: query required: false style: simple - name: valueSetVersion in: query required: false style: simple - name: system in: query required: false style: simple - name: systemVersion in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CodeSystem parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/$subsumes: get: tags: - CodeSystem parameters: - name: codeA in: query required: false style: simple - name: codeB in: query required: false style: simple - name: system in: query required: false style: simple - name: codingA in: query required: false style: simple - name: codingB in: query required: false style: simple - name: version in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CodeSystem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CodeSystem/$lookup: get: tags: - CodeSystem parameters: - name: code in: query required: false style: simple - name: system in: query required: false style: simple - name: coding in: query required: false style: simple - name: version in: query required: false style: simple - name: displayLanguage in: query required: false style: simple - name: property in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CodeSystem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Communication: get: tags: - Communication summary: "search-type: Search for Communication instances" description: This is a search type parameters: - name: subject in: query description: Focus of message style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: part-of in: query description: Part of this action style: simple - name: medium in: query description: A channel of communication style: simple - name: based-on in: query description: Request fulfilled by this communication style: simple - name: patient in: query description: Focus of message style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - name: identifier in: query description: Unique identifier style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - name: received in: query description: When received style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: sent in: query description: When sent style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: sender in: query description: Message sender style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: recipient in: query description: Message recipient style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Message category style: simple - name: status in: query description: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Communication/_search: get: tags: - Communication summary: "search-type: Search for Communication instances" description: This is a search type parameters: - name: subject in: query description: Focus of message style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: part-of in: query description: Part of this action style: simple - name: medium in: query description: A channel of communication style: simple - name: based-on in: query description: Request fulfilled by this communication style: simple - name: patient in: query description: Focus of message style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - name: identifier in: query description: Unique identifier style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - name: received in: query description: When received style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: sent in: query description: When sent style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: sender in: query description: Message sender style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: recipient in: query description: Message recipient style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Message category style: simple - name: status in: query description: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Communication/$validate: get: tags: - Communication parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Communication requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Communication/{id}/$validate: get: tags: - Communication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Communication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Communication/{id}/$meta-delete: post: tags: - Communication description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Communication/{id}/$meta-add: post: tags: - Communication description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Communication/$meta: get: tags: - Communication 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Communication 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Communication/{id}/$meta: get: tags: - Communication description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Communication description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Communication/$expunge: post: tags: - Communication requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Communication/{id}/$expunge: post: tags: - Communication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: subject in: query description: Focus of message style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: medium in: query description: A channel of communication style: simple - name: occurrence in: query description: When scheduled style: simple - name: group-identifier in: query description: Composite request this is part of style: simple - name: based-on in: query description: Fulfills plan or proposal style: simple - name: patient in: query description: Focus of message style: simple - name: requester in: query description: Who/what is requesting service style: simple - name: identifier in: query description: Unique identifier style: simple - name: replaces in: query description: Request(s) replaced by this request style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: priority in: query description: routine | urgent | asap | stat style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: sender in: query description: Message sender style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: recipient in: query description: Message recipient style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Message category style: simple - name: status in: query description: draft | active | on-hold | revoked | completed | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: subject in: query description: Focus of message style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: medium in: query description: A channel of communication style: simple - name: occurrence in: query description: When scheduled style: simple - name: group-identifier in: query description: Composite request this is part of style: simple - name: based-on in: query description: Fulfills plan or proposal style: simple - name: patient in: query description: Focus of message style: simple - name: requester in: query description: Who/what is requesting service style: simple - name: identifier in: query description: Unique identifier style: simple - name: replaces in: query description: Request(s) replaced by this request style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: priority in: query description: routine | urgent | asap | stat style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: sender in: query description: Message sender style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: recipient in: query description: Message recipient style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Message category style: simple - name: status in: query description: draft | active | on-hold | revoked | completed | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CommunicationRequest/$validate: get: tags: - CommunicationRequest parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CommunicationRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CommunicationRequest/{id}/$validate: get: tags: - CommunicationRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CommunicationRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CommunicationRequest/{id}/$meta-delete: post: tags: - CommunicationRequest description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CommunicationRequest/{id}/$meta-add: post: tags: - CommunicationRequest description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CommunicationRequest/$meta: get: tags: - CommunicationRequest 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CommunicationRequest 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CommunicationRequest/{id}/$meta: get: tags: - CommunicationRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CommunicationRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CommunicationRequest/$expunge: post: tags: - CommunicationRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CommunicationRequest/{id}/$expunge: post: tags: - CommunicationRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: code in: query description: Patient | Encounter | RelatedPerson | Practitioner | Device style: simple - 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" style: simple - name: resource in: query description: Name of resource type style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: description in: query description: "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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: context-quantity in: query description: "Multiple Resources: \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" style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: context in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: context-type-quantity in: query description: "Multiple Resources: \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" style: simple - 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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: code in: query description: Patient | Encounter | RelatedPerson | Practitioner | Device style: simple - 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" style: simple - name: resource in: query description: Name of resource type style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: description in: query description: "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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: context-quantity in: query description: "Multiple Resources: \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" style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: context in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: context-type-quantity in: query description: "Multiple Resources: \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" style: simple - 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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CompartmentDefinition/$validate: get: tags: - CompartmentDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CompartmentDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CompartmentDefinition/{id}/$validate: get: tags: - CompartmentDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CompartmentDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CompartmentDefinition/{id}/$meta-delete: post: tags: - CompartmentDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CompartmentDefinition/{id}/$meta-add: post: tags: - CompartmentDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CompartmentDefinition/$meta: get: tags: - CompartmentDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CompartmentDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CompartmentDefinition/{id}/$meta: get: tags: - CompartmentDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CompartmentDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CompartmentDefinition/$expunge: post: tags: - CompartmentDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CompartmentDefinition/{id}/$expunge: post: tags: - CompartmentDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: subject in: query description: Who and/or what the composition is about style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: confidentiality in: query description: As defined by affinity domain style: simple - name: section in: query description: Classification of section (recommended) style: simple - 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" style: simple - name: title in: query description: Human Readable name/title style: simple - 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" style: simple - name: context in: query description: Code(s) that apply to the event being documented style: simple - 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" style: simple - name: period in: query description: The period covered by the documentation style: simple - name: related-id in: query description: Target of the relationship style: simple - name: author in: query description: Who and/or what authored the composition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - name: attester in: query description: Who attested the composition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: entry in: query description: A reference to data that supports this section style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: related-ref in: query description: Target of the relationship style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Categorization of Composition style: simple - name: status in: query description: preliminary | final | amended | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: subject in: query description: Who and/or what the composition is about style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: confidentiality in: query description: As defined by affinity domain style: simple - name: section in: query description: Classification of section (recommended) style: simple - 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" style: simple - name: title in: query description: Human Readable name/title style: simple - 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" style: simple - name: context in: query description: Code(s) that apply to the event being documented style: simple - 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" style: simple - name: period in: query description: The period covered by the documentation style: simple - name: related-id in: query description: Target of the relationship style: simple - name: author in: query description: Who and/or what authored the composition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - name: attester in: query description: Who attested the composition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: entry in: query description: A reference to data that supports this section style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: related-ref in: query description: Target of the relationship style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Categorization of Composition style: simple - name: status in: query description: preliminary | final | amended | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Composition/$validate: get: tags: - Composition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Composition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Composition/{id}/$validate: get: tags: - Composition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Composition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Composition/{id}/$meta-delete: post: tags: - Composition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Composition/{id}/$meta-add: post: tags: - Composition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Composition/$meta: get: tags: - Composition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Composition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Composition/{id}/$meta: get: tags: - Composition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Composition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Composition/$expunge: post: tags: - Composition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Composition/{id}/$expunge: post: tags: - Composition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Composition/{id}/$document: get: tags: - Composition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: _count in: query description: Results from this method are returned across multiple pages. This parameter controls the size of those pages. required: false style: simple - name: _offset in: query description: Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page. required: false style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Composition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: other in: query description: canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped style: simple - 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" style: simple - name: dependson in: query description: Reference to property mapping depends on style: simple - name: target-system in: query description: Target system that the concepts are to be mapped to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: source in: query description: The source value set that contains the concepts that are being mapped style: simple - 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" style: simple - 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" style: simple - name: source-uri in: query description: The source value set that contains the concepts that are being mapped style: simple - 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" style: simple - 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" style: simple - name: source-system in: query description: Source system where concepts to be mapped are defined style: simple - name: target-code in: query description: Code that identifies the target element style: simple - name: target-uri in: query description: The target value set which provides context for the mappings style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [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" style: simple - name: product in: query description: Reference to property mapping depends on style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - name: target in: query description: The target value set which provides context for the mappings style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: source-code in: query description: Identifies element being mapped style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: other in: query description: canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped style: simple - 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" style: simple - name: dependson in: query description: Reference to property mapping depends on style: simple - name: target-system in: query description: Target system that the concepts are to be mapped to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: source in: query description: The source value set that contains the concepts that are being mapped style: simple - 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" style: simple - 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" style: simple - name: source-uri in: query description: The source value set that contains the concepts that are being mapped style: simple - 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" style: simple - 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" style: simple - name: source-system in: query description: Source system where concepts to be mapped are defined style: simple - name: target-code in: query description: Code that identifies the target element style: simple - name: target-uri in: query description: The target value set which provides context for the mappings style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [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" style: simple - name: product in: query description: Reference to property mapping depends on style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - name: target in: query description: The target value set which provides context for the mappings style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: source-code in: query description: Identifies element being mapped style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ConceptMap/$validate: get: tags: - ConceptMap parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ConceptMap requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ConceptMap/{id}/$validate: get: tags: - ConceptMap parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ConceptMap parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ConceptMap/{id}/$meta-delete: post: tags: - ConceptMap description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ConceptMap/{id}/$meta-add: post: tags: - ConceptMap description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ConceptMap/$meta: get: tags: - ConceptMap 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ConceptMap 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ConceptMap/{id}/$meta: get: tags: - ConceptMap description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ConceptMap description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ConceptMap/$expunge: post: tags: - ConceptMap requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ConceptMap/{id}/$expunge: post: tags: - ConceptMap parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ConceptMap/$translate: get: tags: - ConceptMap parameters: - name: url in: query required: false style: simple - name: conceptMapVersion in: query required: false style: simple - name: code in: query required: false style: simple - name: system in: query required: false style: simple - name: version in: query required: false style: simple - name: source in: query required: false style: simple - name: coding in: query required: false style: simple - name: target in: query required: false style: simple - name: targetsystem in: query required: false style: simple - name: reverse in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ConceptMap requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ConceptMap/{id}/$translate: get: tags: - ConceptMap parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: url in: query required: false style: simple - name: conceptMapVersion in: query required: false style: simple - name: code in: query required: false style: simple - name: system in: query required: false style: simple - name: version in: query required: false style: simple - name: source in: query required: false style: simple - name: coding in: query required: false style: simple - name: target in: query required: false style: simple - name: targetsystem in: query required: false style: simple - name: reverse in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ConceptMap parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - 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" style: simple - name: evidence in: query description: Manifestation/symptom style: simple - name: subject in: query description: Who has the condition? style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: verification-status in: query description: unconfirmed | provisional | differential | confirmed | refuted | entered-in-error style: simple - name: clinical-status in: query description: The clinical status of the condition style: simple - name: onset-date in: query description: Date related onsets (dateTime and Period) style: simple - name: abatement-date in: query description: Date-related abatements (dateTime and period) style: simple - 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" style: simple - name: abatement-age in: query description: Abatement as age or age range style: simple - name: evidence-detail in: query description: Supporting information found elsewhere style: simple - name: severity in: query description: The severity of the condition style: simple - 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" style: simple - name: recorded-date in: query description: Date record was first recorded style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: asserter in: query description: Person who asserts this condition style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: stage in: query description: Simple summary (disease specific) style: simple - name: abatement-string in: query description: Abatement as a string style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: onset-age in: query description: Onsets as age or age range style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: body-site in: query description: "Anatomical location, if relevant" style: simple - name: category in: query description: The category of the condition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - 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" style: simple - name: evidence in: query description: Manifestation/symptom style: simple - name: subject in: query description: Who has the condition? style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: verification-status in: query description: unconfirmed | provisional | differential | confirmed | refuted | entered-in-error style: simple - name: clinical-status in: query description: The clinical status of the condition style: simple - name: onset-date in: query description: Date related onsets (dateTime and Period) style: simple - name: abatement-date in: query description: Date-related abatements (dateTime and period) style: simple - 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" style: simple - name: abatement-age in: query description: Abatement as age or age range style: simple - name: evidence-detail in: query description: Supporting information found elsewhere style: simple - name: severity in: query description: The severity of the condition style: simple - 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" style: simple - name: recorded-date in: query description: Date record was first recorded style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounter created as part of style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: asserter in: query description: Person who asserts this condition style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: stage in: query description: Simple summary (disease specific) style: simple - name: abatement-string in: query description: Abatement as a string style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: onset-age in: query description: Onsets as age or age range style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: body-site in: query description: "Anatomical location, if relevant" style: simple - name: category in: query description: The category of the condition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Condition/$validate: get: tags: - Condition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Condition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Condition/{id}/$validate: get: tags: - Condition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Condition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Condition/{id}/$meta-delete: post: tags: - Condition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Condition/{id}/$meta-add: post: tags: - Condition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Condition/$meta: get: tags: - Condition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Condition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Condition/{id}/$meta: get: tags: - Condition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Condition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Condition/$expunge: post: tags: - Condition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Condition/{id}/$expunge: post: tags: - Condition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: data in: query description: The actual data reference style: simple - name: purpose in: query description: Context of activities covered by this rule style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: source-reference in: query description: "Search by reference to a Consent, DocumentReference, Contract\ \ or QuestionnaireResponse" style: simple - 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" style: simple - name: scope in: query description: Which of the four areas this resource covers (extensible) style: simple - name: action in: query description: Actions controlled by this rule style: simple - 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" style: simple - name: period in: query description: Timeframe for this rule style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: actor in: query description: "Resource for the actor (or group, by role)" style: simple - name: security-label in: query description: Security Labels that define affected resources style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: Custodian of the consent style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: consentor in: query description: Who is agreeing to the policy and rules style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Classification of the consent statement - for indexing/retrieval style: simple - name: status in: query description: draft | proposed | active | rejected | inactive | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: data in: query description: The actual data reference style: simple - name: purpose in: query description: Context of activities covered by this rule style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: source-reference in: query description: "Search by reference to a Consent, DocumentReference, Contract\ \ or QuestionnaireResponse" style: simple - 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" style: simple - name: scope in: query description: Which of the four areas this resource covers (extensible) style: simple - name: action in: query description: Actions controlled by this rule style: simple - 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" style: simple - name: period in: query description: Timeframe for this rule style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: actor in: query description: "Resource for the actor (or group, by role)" style: simple - name: security-label in: query description: Security Labels that define affected resources style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: Custodian of the consent style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: consentor in: query description: Who is agreeing to the policy and rules style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Classification of the consent statement - for indexing/retrieval style: simple - name: status in: query description: draft | proposed | active | rejected | inactive | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Consent/$validate: get: tags: - Consent parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Consent requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Consent/{id}/$validate: get: tags: - Consent parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Consent parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Consent/{id}/$meta-delete: post: tags: - Consent description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Consent/{id}/$meta-add: post: tags: - Consent description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Consent/$meta: get: tags: - Consent 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Consent 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Consent/{id}/$meta: get: tags: - Consent description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Consent description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Consent/$expunge: post: tags: - Consent requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Consent/{id}/$expunge: post: tags: - Consent parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: instantiates in: query description: A source definition of the contract style: simple - name: subject in: query description: The identity of the subject of the contract style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: url in: query description: The basal contract definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The identity of the subject of the contract (if a patient) style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: authority in: query description: The authority of the contract style: simple - name: domain in: query description: The domain of the contract style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: issued in: query description: The date/time the contract was issued style: simple - name: signer in: query description: Contract Signatory Party style: simple - name: status in: query description: The status of the contract style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: instantiates in: query description: A source definition of the contract style: simple - name: subject in: query description: The identity of the subject of the contract style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: url in: query description: The basal contract definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The identity of the subject of the contract (if a patient) style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: authority in: query description: The authority of the contract style: simple - name: domain in: query description: The domain of the contract style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: issued in: query description: The date/time the contract was issued style: simple - name: signer in: query description: Contract Signatory Party style: simple - name: status in: query description: The status of the contract style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Contract/$validate: get: tags: - Contract parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Contract requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Contract/{id}/$validate: get: tags: - Contract parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Contract parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Contract/{id}/$meta-delete: post: tags: - Contract description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Contract/{id}/$meta-add: post: tags: - Contract description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Contract/$meta: get: tags: - Contract 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Contract 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Contract/{id}/$meta: get: tags: - Contract description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Contract description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Contract/$expunge: post: tags: - Contract requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Contract/{id}/$expunge: post: tags: - Contract parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: subscriber in: query description: Reference to the subscriber style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: "The kind of coverage (health plan, auto, Workers Compensation)" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: payor in: query description: The identity of the insurer or party paying for services style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: beneficiary in: query description: Covered party style: simple - name: patient in: query description: Retrieve coverages for a patient style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: class-value in: query description: "Value of the class (eg. Plan number, group number)" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: class-type in: query description: "Coverage class (eg. plan, group)" style: simple - name: dependent in: query description: Dependent number style: simple - name: policy-holder in: query description: Reference to the policyholder style: simple - name: status in: query description: The status of the Coverage style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: subscriber in: query description: Reference to the subscriber style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: "The kind of coverage (health plan, auto, Workers Compensation)" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: payor in: query description: The identity of the insurer or party paying for services style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: beneficiary in: query description: Covered party style: simple - name: patient in: query description: Retrieve coverages for a patient style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: class-value in: query description: "Value of the class (eg. Plan number, group number)" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: class-type in: query description: "Coverage class (eg. plan, group)" style: simple - name: dependent in: query description: Dependent number style: simple - name: policy-holder in: query description: Reference to the policyholder style: simple - name: status in: query description: The status of the Coverage style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Coverage/$validate: get: tags: - Coverage parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Coverage requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Coverage/{id}/$validate: get: tags: - Coverage parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Coverage parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Coverage/{id}/$meta-delete: post: tags: - Coverage description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Coverage/{id}/$meta-add: post: tags: - Coverage description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Coverage/$meta: get: tags: - Coverage 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Coverage 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Coverage/{id}/$meta: get: tags: - Coverage description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Coverage description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Coverage/$expunge: post: tags: - Coverage requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Coverage/{id}/$expunge: post: tags: - Coverage parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: created in: query description: The creation date for the EOB style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: provider in: query description: The reference to the provider style: simple - name: patient in: query description: The reference to the patient style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: enterer in: query description: The party who is responsible for the request style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: facility in: query description: Facility responsible for the goods and services style: simple - name: status in: query description: The status of the EligibilityRequest style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: created in: query description: The creation date for the EOB style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: provider in: query description: The reference to the provider style: simple - name: patient in: query description: The reference to the patient style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: enterer in: query description: The party who is responsible for the request style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: facility in: query description: Facility responsible for the goods and services style: simple - name: status in: query description: The status of the EligibilityRequest style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityRequest/$validate: get: tags: - CoverageEligibilityRequest parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CoverageEligibilityRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityRequest/{id}/$validate: get: tags: - CoverageEligibilityRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CoverageEligibilityRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityRequest/{id}/$meta-delete: post: tags: - CoverageEligibilityRequest description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityRequest/{id}/$meta-add: post: tags: - CoverageEligibilityRequest description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityRequest/$meta: get: tags: - CoverageEligibilityRequest 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CoverageEligibilityRequest 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityRequest/{id}/$meta: get: tags: - CoverageEligibilityRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CoverageEligibilityRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityRequest/$expunge: post: tags: - CoverageEligibilityRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityRequest/{id}/$expunge: post: tags: - CoverageEligibilityRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: request in: query description: The EligibilityRequest reference style: simple - name: created in: query description: The creation date style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: requestor in: query description: The EligibilityRequest provider style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: disposition in: query description: The contents of the disposition message style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: insurer in: query description: The organization which generated this resource style: simple - name: patient in: query description: The reference to the patient style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: outcome in: query description: The processing outcome style: simple - name: status in: query description: The EligibilityRequest status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: request in: query description: The EligibilityRequest reference style: simple - name: created in: query description: The creation date style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: requestor in: query description: The EligibilityRequest provider style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: disposition in: query description: The contents of the disposition message style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: insurer in: query description: The organization which generated this resource style: simple - name: patient in: query description: The reference to the patient style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: outcome in: query description: The processing outcome style: simple - name: status in: query description: The EligibilityRequest status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityResponse/$validate: get: tags: - CoverageEligibilityResponse parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CoverageEligibilityResponse requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityResponse/{id}/$validate: get: tags: - CoverageEligibilityResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CoverageEligibilityResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityResponse/{id}/$meta-delete: post: tags: - CoverageEligibilityResponse description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityResponse/{id}/$meta-add: post: tags: - CoverageEligibilityResponse description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityResponse/$meta: get: tags: - CoverageEligibilityResponse 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CoverageEligibilityResponse 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityResponse/{id}/$meta: get: tags: - CoverageEligibilityResponse description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - CoverageEligibilityResponse description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityResponse/$expunge: post: tags: - CoverageEligibilityResponse requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /CoverageEligibilityResponse/{id}/$expunge: post: tags: - CoverageEligibilityResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: code in: query description: "Issue Category, e.g. drug-drug, duplicate therapy, etc." style: simple - name: author in: query description: The provider or device that identified the issue style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: identified in: query description: When identified style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - 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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: implicated in: query description: Problem resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: code in: query description: "Issue Category, e.g. drug-drug, duplicate therapy, etc." style: simple - name: author in: query description: The provider or device that identified the issue style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: identified in: query description: When identified style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - 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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: implicated in: query description: Problem resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DetectedIssue/$validate: get: tags: - DetectedIssue parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DetectedIssue requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DetectedIssue/{id}/$validate: get: tags: - DetectedIssue parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DetectedIssue parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DetectedIssue/{id}/$meta-delete: post: tags: - DetectedIssue description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DetectedIssue/{id}/$meta-add: post: tags: - DetectedIssue description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DetectedIssue/$meta: get: tags: - DetectedIssue 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DetectedIssue 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DetectedIssue/{id}/$meta: get: tags: - DetectedIssue description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DetectedIssue description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DetectedIssue/$expunge: post: tags: - DetectedIssue requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DetectedIssue/{id}/$expunge: post: tags: - DetectedIssue parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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) style: simple - name: identifier in: query description: "Instance id from manufacturer, owner, and others" style: simple - name: udi-carrier in: query description: UDI Barcode (RFID or other technology) string in *HRF* format. style: simple - name: device-name in: query description: A server defined search that may match any of the string fields in Device.deviceName or Device.type. style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: The type of the device style: simple - name: url in: query description: Network address to contact device style: simple - name: manufacturer in: query description: The manufacturer of the device style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Patient information, if the resource is affixed to a person" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The organization responsible for the device style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: "A location, where the resource is found" style: simple - name: model in: query description: The model of the device style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: active | inactive | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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) style: simple - name: identifier in: query description: "Instance id from manufacturer, owner, and others" style: simple - name: udi-carrier in: query description: UDI Barcode (RFID or other technology) string in *HRF* format. style: simple - name: device-name in: query description: A server defined search that may match any of the string fields in Device.deviceName or Device.type. style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: The type of the device style: simple - name: url in: query description: Network address to contact device style: simple - name: manufacturer in: query description: The manufacturer of the device style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Patient information, if the resource is affixed to a person" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The organization responsible for the device style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: "A location, where the resource is found" style: simple - name: model in: query description: The model of the device style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: active | inactive | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Device/$validate: get: tags: - Device parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Device requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Device/{id}/$validate: get: tags: - Device parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Device parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Device/{id}/$meta-delete: post: tags: - Device description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Device/{id}/$meta-add: post: tags: - Device description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Device/$meta: get: tags: - Device 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Device 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Device/{id}/$meta: get: tags: - Device description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Device description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Device/$expunge: post: tags: - Device requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Device/{id}/$expunge: post: tags: - Device parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceDefinition: get: tags: - DeviceDefinition summary: "search-type: Search for DeviceDefinition instances" description: This is a search type parameters: - name: identifier in: query description: The identifier of the component style: simple - name: parent in: query description: The parent DeviceDefinition resource style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: The device component type style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceDefinition/_search: get: tags: - DeviceDefinition summary: "search-type: Search for DeviceDefinition instances" description: This is a search type parameters: - name: identifier in: query description: The identifier of the component style: simple - name: parent in: query description: The parent DeviceDefinition resource style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: The device component type style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceDefinition/$validate: get: tags: - DeviceDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceDefinition/{id}/$validate: get: tags: - DeviceDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceDefinition/{id}/$meta-delete: post: tags: - DeviceDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceDefinition/{id}/$meta-add: post: tags: - DeviceDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceDefinition/$meta: get: tags: - DeviceDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceDefinition/{id}/$meta: get: tags: - DeviceDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceDefinition/$expunge: post: tags: - DeviceDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceDefinition/{id}/$expunge: post: tags: - DeviceDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: parent in: query description: The parent DeviceMetric resource style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: source in: query description: The device resource style: simple - name: type in: query description: The component type style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: The category of the metric style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: parent in: query description: The parent DeviceMetric resource style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: source in: query description: The device resource style: simple - name: type in: query description: The component type style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: The category of the metric style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceMetric/$validate: get: tags: - DeviceMetric parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceMetric requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceMetric/{id}/$validate: get: tags: - DeviceMetric parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceMetric parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceMetric/{id}/$meta-delete: post: tags: - DeviceMetric description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceMetric/{id}/$meta-add: post: tags: - DeviceMetric description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceMetric/$meta: get: tags: - DeviceMetric 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceMetric 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceMetric/{id}/$meta: get: tags: - DeviceMetric description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceMetric description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceMetric/$expunge: post: tags: - DeviceMetric requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceMetric/{id}/$expunge: post: tags: - DeviceMetric parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - 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" style: simple - name: subject in: query description: Individual the service is ordered for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: group-identifier in: query description: Composite request this is part of style: simple - name: based-on in: query description: Plan/proposal/order fulfilled by this request style: simple - 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" style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - name: requester in: query description: Who/what is requesting service style: simple - name: identifier in: query description: "Multiple Resources: \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" style: simple - name: performer in: query description: Desired performer for service style: simple - name: event-date in: query description: When service should occur style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: authored-on in: query description: When the request transitioned to being actionable style: simple - name: intent in: query description: proposal | plan | original-order |reflex-order style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: device in: query description: Reference to resource that is being requested/ordered style: simple - name: prior-request in: query description: Request takes the place of referenced completed or terminated requests style: simple - name: status in: query description: entered-in-error | draft | active |suspended | completed style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - 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" style: simple - name: subject in: query description: Individual the service is ordered for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: group-identifier in: query description: Composite request this is part of style: simple - name: based-on in: query description: Plan/proposal/order fulfilled by this request style: simple - 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" style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - name: requester in: query description: Who/what is requesting service style: simple - name: identifier in: query description: "Multiple Resources: \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" style: simple - name: performer in: query description: Desired performer for service style: simple - name: event-date in: query description: When service should occur style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: authored-on in: query description: When the request transitioned to being actionable style: simple - name: intent in: query description: proposal | plan | original-order |reflex-order style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: device in: query description: Reference to resource that is being requested/ordered style: simple - name: prior-request in: query description: Request takes the place of referenced completed or terminated requests style: simple - name: status in: query description: entered-in-error | draft | active |suspended | completed style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceRequest/$validate: get: tags: - DeviceRequest parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceRequest/{id}/$validate: get: tags: - DeviceRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceRequest/{id}/$meta-delete: post: tags: - DeviceRequest description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceRequest/{id}/$meta-add: post: tags: - DeviceRequest description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceRequest/$meta: get: tags: - DeviceRequest 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceRequest 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceRequest/{id}/$meta: get: tags: - DeviceRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceRequest/$expunge: post: tags: - DeviceRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceRequest/{id}/$expunge: post: tags: - DeviceRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: subject in: query description: Search by subject style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: device in: query description: Search by device style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: subject in: query description: Search by subject style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: device in: query description: Search by device style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceUseStatement/$validate: get: tags: - DeviceUseStatement parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceUseStatement requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceUseStatement/{id}/$validate: get: tags: - DeviceUseStatement parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceUseStatement parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceUseStatement/{id}/$meta-delete: post: tags: - DeviceUseStatement description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceUseStatement/{id}/$meta-add: post: tags: - DeviceUseStatement description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceUseStatement/$meta: get: tags: - DeviceUseStatement 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceUseStatement 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceUseStatement/{id}/$meta: get: tags: - DeviceUseStatement description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DeviceUseStatement description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceUseStatement/$expunge: post: tags: - DeviceUseStatement requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DeviceUseStatement/{id}/$expunge: post: tags: - DeviceUseStatement parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: subject in: query description: The subject of the report style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: media in: query description: A reference to the image source. style: simple - name: conclusion in: query description: A coded conclusion (interpretation/impression) on the report style: simple - name: result in: query description: Link to an atomic result (observation resource) style: simple - name: based-on in: query description: Reference to the service request. style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: specimen in: query description: The specimen details style: simple - name: issued in: query description: When the report was issued style: simple - name: identifier in: query description: "Multiple Resources: \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" style: simple - name: performer in: query description: Who is responsible for the report style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Which diagnostic discipline/department created the report style: simple - name: results-interpreter in: query description: Who was the source of the report style: simple - name: status in: query description: The status of the report style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DiagnosticReport/_history: get: tags: - DiagnosticReport summary: "type-history: Fetch the resource change history for all resources\ \ of type DiagnosticReport" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: subject in: query description: The subject of the report style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: media in: query description: A reference to the image source. style: simple - name: conclusion in: query description: A coded conclusion (interpretation/impression) on the report style: simple - name: result in: query description: Link to an atomic result (observation resource) style: simple - name: based-on in: query description: Reference to the service request. style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: specimen in: query description: The specimen details style: simple - name: issued in: query description: When the report was issued style: simple - name: identifier in: query description: "Multiple Resources: \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" style: simple - name: performer in: query description: Who is responsible for the report style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Which diagnostic discipline/department created the report style: simple - name: results-interpreter in: query description: Who was the source of the report style: simple - name: status in: query description: The status of the report style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DiagnosticReport/$validate: get: tags: - DiagnosticReport parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DiagnosticReport requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DiagnosticReport/{id}/$validate: get: tags: - DiagnosticReport parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DiagnosticReport parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DiagnosticReport/{id}/$meta-delete: post: tags: - DiagnosticReport description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DiagnosticReport/{id}/$meta-add: post: tags: - DiagnosticReport description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DiagnosticReport/$meta: get: tags: - DiagnosticReport 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DiagnosticReport 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DiagnosticReport/{id}/$meta: get: tags: - DiagnosticReport description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DiagnosticReport description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DiagnosticReport/$expunge: post: tags: - DiagnosticReport requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DiagnosticReport/{id}/$expunge: post: tags: - DiagnosticReport parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: item in: query description: Items in manifest style: simple - name: related-id in: query description: Identifiers of things that are related style: simple - name: author in: query description: Who and/or what authored the DocumentManifest style: simple - name: created in: query description: When this document manifest created style: simple - name: subject in: query description: The subject of the set of documents style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: description in: query description: Human-readable description (title) style: simple - name: source in: query description: The source system/application/software style: simple - name: type in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: related-ref in: query description: Related Resource style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: recipient in: query description: Intended to get notified about this set of documents style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: current | superseded | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: item in: query description: Items in manifest style: simple - name: related-id in: query description: Identifiers of things that are related style: simple - name: author in: query description: Who and/or what authored the DocumentManifest style: simple - name: created in: query description: When this document manifest created style: simple - name: subject in: query description: The subject of the set of documents style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: description in: query description: Human-readable description (title) style: simple - name: source in: query description: The source system/application/software style: simple - name: type in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: related-ref in: query description: Related Resource style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: recipient in: query description: Intended to get notified about this set of documents style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: current | superseded | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentManifest/$validate: get: tags: - DocumentManifest parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DocumentManifest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentManifest/{id}/$validate: get: tags: - DocumentManifest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DocumentManifest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentManifest/{id}/$meta-delete: post: tags: - DocumentManifest description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentManifest/{id}/$meta-add: post: tags: - DocumentManifest description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentManifest/$meta: get: tags: - DocumentManifest 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DocumentManifest 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentManifest/{id}/$meta: get: tags: - DocumentManifest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DocumentManifest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentManifest/$expunge: post: tags: - DocumentManifest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentManifest/{id}/$expunge: post: tags: - DocumentManifest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentReference: get: tags: - DocumentReference summary: "search-type: Search for DocumentReference instances" description: This is a search type parameters: - name: date in: query description: When this document reference was created style: simple - name: subject in: query description: Who/what is the subject of the document style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: description in: query description: Human-readable description style: simple - name: language in: query description: Human language of the content (BCP-47) style: simple - name: type in: query description: "Multiple Resources: \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" style: simple - name: relation in: query description: replaces | transforms | signs | appends style: simple - name: setting in: query description: Additional details about where the content was created (e.g. clinical specialty) style: simple - name: related in: query description: Related identifiers or resources style: simple - 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" style: simple - name: event in: query description: Main clinical acts documented style: simple - name: relationship in: query description: Combination of relation and relatesTo style: simple - name: authenticator in: query description: Who/what authenticated the document style: simple - 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" style: simple - name: period in: query description: Time of service that is being documented style: simple - name: custodian in: query description: Organization which maintains the document style: simple - name: author in: query description: Who and/or what authored the document style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: format in: query description: Format/content rules for the document style: simple - 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" style: simple - name: contenttype in: query description: "Mime type of the content, with charset etc." style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: security-label in: query description: Document security-tags style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: Uri where the data can be found style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Categorization of document style: simple - name: relatesto in: query description: Target of the relationship style: simple - name: facility in: query description: Kind of facility where patient was seen style: simple - name: status in: query description: current | superseded | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentReference/_history: get: tags: - DocumentReference summary: "type-history: Fetch the resource change history for all resources\ \ of type DocumentReference" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: subject in: query description: Who/what is the subject of the document style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: description in: query description: Human-readable description style: simple - name: language in: query description: Human language of the content (BCP-47) style: simple - name: type in: query description: "Multiple Resources: \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" style: simple - name: relation in: query description: replaces | transforms | signs | appends style: simple - name: setting in: query description: Additional details about where the content was created (e.g. clinical specialty) style: simple - name: related in: query description: Related identifiers or resources style: simple - 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" style: simple - name: event in: query description: Main clinical acts documented style: simple - name: relationship in: query description: Combination of relation and relatesTo style: simple - name: authenticator in: query description: Who/what authenticated the document style: simple - 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" style: simple - name: period in: query description: Time of service that is being documented style: simple - name: custodian in: query description: Organization which maintains the document style: simple - name: author in: query description: Who and/or what authored the document style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: format in: query description: Format/content rules for the document style: simple - 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" style: simple - name: contenttype in: query description: "Mime type of the content, with charset etc." style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: security-label in: query description: Document security-tags style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: Uri where the data can be found style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Categorization of document style: simple - name: relatesto in: query description: Target of the relationship style: simple - name: facility in: query description: Kind of facility where patient was seen style: simple - name: status in: query description: current | superseded | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentReference/$validate: get: tags: - DocumentReference parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DocumentReference requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentReference/{id}/$validate: get: tags: - DocumentReference parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DocumentReference parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentReference/{id}/$meta-delete: post: tags: - DocumentReference description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentReference/{id}/$meta-add: post: tags: - DocumentReference description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentReference/$meta: get: tags: - DocumentReference 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DocumentReference 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentReference/{id}/$meta: get: tags: - DocumentReference description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - DocumentReference description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentReference/$expunge: post: tags: - DocumentReference requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /DocumentReference/{id}/$expunge: post: tags: - DocumentReference parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: context-type-value in: query description: A use context type and value assigned to the effect evidence synthesis style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the effect evidence synthesis style: simple - name: description in: query description: The description of the effect evidence synthesis style: simple - name: context-type in: query description: A type of use context assigned to the effect evidence synthesis style: simple - name: title in: query description: The human-friendly name of the effect evidence synthesis style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the effect evidence synthesis style: simple - name: effective in: query description: The time during which the effect evidence synthesis is intended to be in use style: simple - name: context in: query description: A use context assigned to the effect evidence synthesis style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the effect evidence synthesis style: simple - name: identifier in: query description: External identifier for the effect evidence synthesis style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the effect evidence synthesis style: simple - name: url in: query description: The uri that identifies the effect evidence synthesis style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the effect evidence synthesis style: simple - name: publisher in: query description: Name of the publisher of the effect evidence synthesis style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the effect evidence synthesis style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: context-type-value in: query description: A use context type and value assigned to the effect evidence synthesis style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the effect evidence synthesis style: simple - name: description in: query description: The description of the effect evidence synthesis style: simple - name: context-type in: query description: A type of use context assigned to the effect evidence synthesis style: simple - name: title in: query description: The human-friendly name of the effect evidence synthesis style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the effect evidence synthesis style: simple - name: effective in: query description: The time during which the effect evidence synthesis is intended to be in use style: simple - name: context in: query description: A use context assigned to the effect evidence synthesis style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the effect evidence synthesis style: simple - name: identifier in: query description: External identifier for the effect evidence synthesis style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the effect evidence synthesis style: simple - name: url in: query description: The uri that identifies the effect evidence synthesis style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the effect evidence synthesis style: simple - name: publisher in: query description: Name of the publisher of the effect evidence synthesis style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the effect evidence synthesis style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EffectEvidenceSynthesis/$validate: get: tags: - EffectEvidenceSynthesis parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EffectEvidenceSynthesis requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EffectEvidenceSynthesis/{id}/$validate: get: tags: - EffectEvidenceSynthesis parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EffectEvidenceSynthesis parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EffectEvidenceSynthesis/{id}/$meta-delete: post: tags: - EffectEvidenceSynthesis description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EffectEvidenceSynthesis/{id}/$meta-add: post: tags: - EffectEvidenceSynthesis description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EffectEvidenceSynthesis/$meta: get: tags: - EffectEvidenceSynthesis 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EffectEvidenceSynthesis 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EffectEvidenceSynthesis/{id}/$meta: get: tags: - EffectEvidenceSynthesis description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EffectEvidenceSynthesis description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EffectEvidenceSynthesis/$expunge: post: tags: - EffectEvidenceSynthesis requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EffectEvidenceSynthesis/{id}/$expunge: post: tags: - EffectEvidenceSynthesis parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: participant-type in: query description: Role of participant in encounter style: simple - name: subject in: query description: The patient or group present at the encounter style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: appointment in: query description: The appointment that scheduled this encounter style: simple - name: part-of in: query description: Another Encounter this encounter is part of style: simple - name: type in: query description: "Multiple Resources: \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" style: simple - name: participant in: query description: Persons involved in the encounter other than the patient style: simple - name: reason-code in: query description: Coded reason the encounter takes place style: simple - name: based-on in: query description: The ServiceRequest that initiated this encounter style: simple - 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" style: simple - name: location-period in: query description: Time period during which the patient was present at the location style: simple - name: special-arrangement in: query description: "Wheelchair, translator, stretcher, etc." style: simple - name: class in: query description: Classification of patient encounter style: simple - name: identifier in: query description: "Multiple Resources: \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" style: simple - name: practitioner in: query description: Persons involved in the encounter other than the patient style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: episode-of-care in: query description: Episode(s) of care that this encounter should be recorded against style: simple - name: length in: query description: Length of encounter in days style: simple - name: diagnosis in: query description: The diagnosis or procedure relevant to the encounter style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: reason-reference in: query description: Reason the encounter takes place (reference) style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: Location the encounter takes place style: simple - name: service-provider in: query description: The organization (facility) responsible for this encounter style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: account in: query description: The set of accounts that may be used for billing for this Encounter style: simple - name: status in: query description: planned | arrived | triaged | in-progress | onleave | finished | cancelled + style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Encounter/_history: get: tags: - Encounter summary: "type-history: Fetch the resource change history for all resources\ \ of type Encounter" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: participant-type in: query description: Role of participant in encounter style: simple - name: subject in: query description: The patient or group present at the encounter style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: appointment in: query description: The appointment that scheduled this encounter style: simple - name: part-of in: query description: Another Encounter this encounter is part of style: simple - name: type in: query description: "Multiple Resources: \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" style: simple - name: participant in: query description: Persons involved in the encounter other than the patient style: simple - name: reason-code in: query description: Coded reason the encounter takes place style: simple - name: based-on in: query description: The ServiceRequest that initiated this encounter style: simple - 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" style: simple - name: location-period in: query description: Time period during which the patient was present at the location style: simple - name: special-arrangement in: query description: "Wheelchair, translator, stretcher, etc." style: simple - name: class in: query description: Classification of patient encounter style: simple - name: identifier in: query description: "Multiple Resources: \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" style: simple - name: practitioner in: query description: Persons involved in the encounter other than the patient style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: episode-of-care in: query description: Episode(s) of care that this encounter should be recorded against style: simple - name: length in: query description: Length of encounter in days style: simple - name: diagnosis in: query description: The diagnosis or procedure relevant to the encounter style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: reason-reference in: query description: Reason the encounter takes place (reference) style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: Location the encounter takes place style: simple - name: service-provider in: query description: The organization (facility) responsible for this encounter style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: account in: query description: The set of accounts that may be used for billing for this Encounter style: simple - name: status in: query description: planned | arrived | triaged | in-progress | onleave | finished | cancelled + style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Encounter/$validate: get: tags: - Encounter parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Encounter requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Encounter/{id}/$validate: get: tags: - Encounter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Encounter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Encounter/{id}/$meta-delete: post: tags: - Encounter description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Encounter/{id}/$meta-add: post: tags: - Encounter description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Encounter/$meta: get: tags: - Encounter 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Encounter 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Encounter/{id}/$meta: get: tags: - Encounter description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Encounter description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Encounter/$expunge: post: tags: - Encounter requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Encounter/{id}/$expunge: post: tags: - Encounter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Encounter/$everything: get: tags: - Encounter parameters: - name: _count in: query description: Results from this method are returned across multiple pages. This parameter controls the size of those pages. required: false style: simple - name: _offset in: query description: Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page. required: false style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range required: false style: simple - name: _content in: query description: "Filter the resources to return only resources matching the given\ \ _content filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _text in: query description: "Filter the resources to return only resources matching the given\ \ _text filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _filter in: query description: "Filter the resources to return only resources matching the given\ \ _filter filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _type in: query description: "Filter the resources to return only resources matching the given\ \ _type filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _id in: query description: Filter the resources to return based on the patient ids provided. required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Encounter requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Encounter/{id}/$everything: get: tags: - Encounter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: _count in: query description: Results from this method are returned across multiple pages. This parameter controls the size of those pages. required: false style: simple - name: _offset in: query description: Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page. required: false style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range required: false style: simple - name: _content in: query description: "Filter the resources to return only resources matching the given\ \ _content filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _text in: query description: "Filter the resources to return only resources matching the given\ \ _text filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _filter in: query description: "Filter the resources to return only resources matching the given\ \ _filter filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _type in: query description: "Filter the resources to return only resources matching the given\ \ _type filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _id in: query description: Filter the resources to return based on the patient ids provided. required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Encounter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Endpoint: get: tags: - Endpoint summary: "search-type: Search for Endpoint instances" description: This is a search type parameters: - name: identifier in: query description: Identifies this endpoint across multiple systems style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: payload-type in: query description: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: connection-type in: query description: Protocol/Profile/Standard to be used with this endpoint connection style: simple - name: organization in: query description: The organization that is managing the endpoint style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: A name that this endpoint can be identified by style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the Endpoint (usually expected to be active) style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Endpoint/_history: get: tags: - Endpoint summary: "type-history: Fetch the resource change history for all resources\ \ of type Endpoint" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: payload-type in: query description: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: connection-type in: query description: Protocol/Profile/Standard to be used with this endpoint connection style: simple - name: organization in: query description: The organization that is managing the endpoint style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: A name that this endpoint can be identified by style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the Endpoint (usually expected to be active) style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Endpoint/$validate: get: tags: - Endpoint parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Endpoint requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Endpoint/{id}/$validate: get: tags: - Endpoint parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Endpoint parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Endpoint/{id}/$meta-delete: post: tags: - Endpoint description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Endpoint/{id}/$meta-add: post: tags: - Endpoint description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Endpoint/$meta: get: tags: - Endpoint 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Endpoint 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Endpoint/{id}/$meta: get: tags: - Endpoint description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Endpoint description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Endpoint/$expunge: post: tags: - Endpoint requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Endpoint/{id}/$expunge: post: tags: - Endpoint parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentRequest: get: tags: - EnrollmentRequest summary: "search-type: Search for EnrollmentRequest instances" description: This is a search type parameters: - name: identifier in: query description: The business identifier of the Enrollment style: simple - name: subject in: query description: The party to be enrolled style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The party to be enrolled style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the enrollment style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentRequest/_history: get: tags: - EnrollmentRequest summary: "type-history: Fetch the resource change history for all resources\ \ of type EnrollmentRequest" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: subject in: query description: The party to be enrolled style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The party to be enrolled style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the enrollment style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentRequest/$validate: get: tags: - EnrollmentRequest parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EnrollmentRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentRequest/{id}/$validate: get: tags: - EnrollmentRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EnrollmentRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentRequest/{id}/$meta-delete: post: tags: - EnrollmentRequest description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentRequest/{id}/$meta-add: post: tags: - EnrollmentRequest description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentRequest/$meta: get: tags: - EnrollmentRequest 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EnrollmentRequest 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentRequest/{id}/$meta: get: tags: - EnrollmentRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EnrollmentRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentRequest/$expunge: post: tags: - EnrollmentRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentRequest/{id}/$expunge: post: tags: - EnrollmentRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentResponse: get: tags: - EnrollmentResponse summary: "search-type: Search for EnrollmentResponse instances" description: This is a search type parameters: - name: identifier in: query description: The business identifier of the EnrollmentResponse style: simple - name: request in: query description: The reference to the claim style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the enrollment response style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentResponse/_history: get: tags: - EnrollmentResponse summary: "type-history: Fetch the resource change history for all resources\ \ of type EnrollmentResponse" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentResponse/_search: get: tags: - EnrollmentResponse summary: "search-type: Search for EnrollmentResponse instances" description: This is a search type parameters: - name: identifier in: query description: The business identifier of the EnrollmentResponse style: simple - name: request in: query description: The reference to the claim style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the enrollment response style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentResponse/$validate: get: tags: - EnrollmentResponse parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EnrollmentResponse requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentResponse/{id}/$validate: get: tags: - EnrollmentResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EnrollmentResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentResponse/{id}/$meta-delete: post: tags: - EnrollmentResponse description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentResponse/{id}/$meta-add: post: tags: - EnrollmentResponse description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentResponse/$meta: get: tags: - EnrollmentResponse 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EnrollmentResponse 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentResponse/{id}/$meta: get: tags: - EnrollmentResponse description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EnrollmentResponse description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentResponse/$expunge: post: tags: - EnrollmentResponse requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EnrollmentResponse/{id}/$expunge: post: tags: - EnrollmentResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: "Multiple Resources: \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" style: simple - name: incoming-referral in: query description: Incoming Referral Request style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: condition in: query description: Conditions/problems/diagnoses this episode of care is for style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The organization that has assumed the specific responsibilities of this EpisodeOfCare style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: care-manager in: query description: Care manager/care coordinator for the patient style: simple - name: status in: query description: The current status of the Episode of Care as provided (does not check the status history collection) style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EpisodeOfCare/_history: get: tags: - EpisodeOfCare summary: "type-history: Fetch the resource change history for all resources\ \ of type EpisodeOfCare" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: "Multiple Resources: \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" style: simple - name: incoming-referral in: query description: Incoming Referral Request style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: condition in: query description: Conditions/problems/diagnoses this episode of care is for style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The organization that has assumed the specific responsibilities of this EpisodeOfCare style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: care-manager in: query description: Care manager/care coordinator for the patient style: simple - name: status in: query description: The current status of the Episode of Care as provided (does not check the status history collection) style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EpisodeOfCare/$validate: get: tags: - EpisodeOfCare parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EpisodeOfCare requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EpisodeOfCare/{id}/$validate: get: tags: - EpisodeOfCare parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EpisodeOfCare parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EpisodeOfCare/{id}/$meta-delete: post: tags: - EpisodeOfCare description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EpisodeOfCare/{id}/$meta-add: post: tags: - EpisodeOfCare description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EpisodeOfCare/$meta: get: tags: - EpisodeOfCare 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EpisodeOfCare 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EpisodeOfCare/{id}/$meta: get: tags: - EpisodeOfCare description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EpisodeOfCare description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EpisodeOfCare/$expunge: post: tags: - EpisodeOfCare requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EpisodeOfCare/{id}/$expunge: post: tags: - EpisodeOfCare parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EventDefinition: get: tags: - EventDefinition summary: "search-type: Search for EventDefinition instances" description: This is a search type parameters: - name: date in: query description: The event definition publication date style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the event definition style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the event definition style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the event definition style: simple - name: context-type in: query description: A type of use context assigned to the event definition style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the event definition style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the event definition style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the event definition is intended to be in use style: simple - name: context in: query description: A use context assigned to the event definition style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the event definition style: simple - name: identifier in: query description: External identifier for the event definition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the event definition style: simple - name: url in: query description: The uri that identifies the event definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the event definition style: simple - name: publisher in: query description: Name of the publisher of the event definition style: simple - name: topic in: query description: Topics associated with the module style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the event definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EventDefinition/_history: get: tags: - EventDefinition summary: "type-history: Fetch the resource change history for all resources\ \ of type EventDefinition" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the event definition style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the event definition style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the event definition style: simple - name: context-type in: query description: A type of use context assigned to the event definition style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the event definition style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the event definition style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the event definition is intended to be in use style: simple - name: context in: query description: A use context assigned to the event definition style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the event definition style: simple - name: identifier in: query description: External identifier for the event definition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the event definition style: simple - name: url in: query description: The uri that identifies the event definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the event definition style: simple - name: publisher in: query description: Name of the publisher of the event definition style: simple - name: topic in: query description: Topics associated with the module style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the event definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EventDefinition/$validate: get: tags: - EventDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EventDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EventDefinition/{id}/$validate: get: tags: - EventDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EventDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EventDefinition/{id}/$meta-delete: post: tags: - EventDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EventDefinition/{id}/$meta-add: post: tags: - EventDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EventDefinition/$meta: get: tags: - EventDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EventDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EventDefinition/{id}/$meta: get: tags: - EventDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EventDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EventDefinition/$expunge: post: tags: - EventDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EventDefinition/{id}/$expunge: post: tags: - EventDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Evidence: get: tags: - Evidence summary: "search-type: Search for Evidence instances" description: This is a search type parameters: - name: date in: query description: The evidence publication date style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the evidence style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the evidence style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the evidence style: simple - name: context-type in: query description: A type of use context assigned to the evidence style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the evidence style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the evidence style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the evidence is intended to be in use style: simple - name: context in: query description: A use context assigned to the evidence style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the evidence style: simple - name: identifier in: query description: External identifier for the evidence style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the evidence style: simple - name: url in: query description: The uri that identifies the evidence style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the evidence style: simple - name: publisher in: query description: Name of the publisher of the evidence style: simple - name: topic in: query description: Topics associated with the Evidence style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the evidence style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Evidence/_history: get: tags: - Evidence summary: "type-history: Fetch the resource change history for all resources\ \ of type Evidence" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the evidence style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the evidence style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the evidence style: simple - name: context-type in: query description: A type of use context assigned to the evidence style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the evidence style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the evidence style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the evidence is intended to be in use style: simple - name: context in: query description: A use context assigned to the evidence style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the evidence style: simple - name: identifier in: query description: External identifier for the evidence style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the evidence style: simple - name: url in: query description: The uri that identifies the evidence style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the evidence style: simple - name: publisher in: query description: Name of the publisher of the evidence style: simple - name: topic in: query description: Topics associated with the Evidence style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the evidence style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Evidence/$validate: get: tags: - Evidence parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Evidence requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Evidence/{id}/$validate: get: tags: - Evidence parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Evidence parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Evidence/{id}/$meta-delete: post: tags: - Evidence description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Evidence/{id}/$meta-add: post: tags: - Evidence description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Evidence/$meta: get: tags: - Evidence 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Evidence 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Evidence/{id}/$meta: get: tags: - Evidence description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Evidence description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Evidence/$expunge: post: tags: - Evidence requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Evidence/{id}/$expunge: post: tags: - Evidence parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EvidenceVariable: get: tags: - EvidenceVariable summary: "search-type: Search for EvidenceVariable instances" description: This is a search type parameters: - name: date in: query description: The evidence variable publication date style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the evidence variable style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the evidence variable style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the evidence variable style: simple - name: context-type in: query description: A type of use context assigned to the evidence variable style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the evidence variable style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the evidence variable style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the evidence variable is intended to be in use style: simple - name: context in: query description: A use context assigned to the evidence variable style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the evidence variable style: simple - name: identifier in: query description: External identifier for the evidence variable style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the evidence variable style: simple - name: url in: query description: The uri that identifies the evidence variable style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the evidence variable style: simple - name: publisher in: query description: Name of the publisher of the evidence variable style: simple - name: topic in: query description: Topics associated with the EvidenceVariable style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the evidence variable style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EvidenceVariable/_history: get: tags: - EvidenceVariable summary: "type-history: Fetch the resource change history for all resources\ \ of type EvidenceVariable" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the evidence variable style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the evidence variable style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the evidence variable style: simple - name: context-type in: query description: A type of use context assigned to the evidence variable style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the evidence variable style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the evidence variable style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the evidence variable is intended to be in use style: simple - name: context in: query description: A use context assigned to the evidence variable style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the evidence variable style: simple - name: identifier in: query description: External identifier for the evidence variable style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the evidence variable style: simple - name: url in: query description: The uri that identifies the evidence variable style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the evidence variable style: simple - name: publisher in: query description: Name of the publisher of the evidence variable style: simple - name: topic in: query description: Topics associated with the EvidenceVariable style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the evidence variable style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EvidenceVariable/$validate: get: tags: - EvidenceVariable parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EvidenceVariable requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EvidenceVariable/{id}/$validate: get: tags: - EvidenceVariable parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EvidenceVariable parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EvidenceVariable/{id}/$meta-delete: post: tags: - EvidenceVariable description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EvidenceVariable/{id}/$meta-add: post: tags: - EvidenceVariable description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EvidenceVariable/$meta: get: tags: - EvidenceVariable 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EvidenceVariable 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EvidenceVariable/{id}/$meta: get: tags: - EvidenceVariable description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - EvidenceVariable description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EvidenceVariable/$expunge: post: tags: - EvidenceVariable requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /EvidenceVariable/{id}/$expunge: post: tags: - EvidenceVariable parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExampleScenario: get: tags: - ExampleScenario summary: "search-type: Search for ExampleScenario instances" description: This is a search type parameters: - name: date in: query description: The example scenario publication date style: simple - name: identifier in: query description: External identifier for the example scenario style: simple - name: context-type-value in: query description: A use context type and value assigned to the example scenario style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the example scenario style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: context-type in: query description: A type of use context assigned to the example scenario style: simple - name: version in: query description: The business version of the example scenario style: simple - name: url in: query description: The uri that identifies the example scenario style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the example scenario style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: context in: query description: A use context assigned to the example scenario style: simple - name: name in: query description: Computationally friendly name of the example scenario style: simple - name: publisher in: query description: Name of the publisher of the example scenario style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the example scenario style: simple - name: status in: query description: The current status of the example scenario style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: External identifier for the example scenario style: simple - name: context-type-value in: query description: A use context type and value assigned to the example scenario style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the example scenario style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: context-type in: query description: A type of use context assigned to the example scenario style: simple - name: version in: query description: The business version of the example scenario style: simple - name: url in: query description: The uri that identifies the example scenario style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the example scenario style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: context in: query description: A use context assigned to the example scenario style: simple - name: name in: query description: Computationally friendly name of the example scenario style: simple - name: publisher in: query description: Name of the publisher of the example scenario style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the example scenario style: simple - name: status in: query description: The current status of the example scenario style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExampleScenario/$validate: get: tags: - ExampleScenario parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ExampleScenario requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExampleScenario/{id}/$validate: get: tags: - ExampleScenario parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ExampleScenario parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExampleScenario/{id}/$meta-delete: post: tags: - ExampleScenario description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExampleScenario/{id}/$meta-add: post: tags: - ExampleScenario description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExampleScenario/$meta: get: tags: - ExampleScenario 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ExampleScenario 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExampleScenario/{id}/$meta: get: tags: - ExampleScenario description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ExampleScenario description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExampleScenario/$expunge: post: tags: - ExampleScenario requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExampleScenario/{id}/$expunge: post: tags: - ExampleScenario parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExplanationOfBenefit: get: tags: - ExplanationOfBenefit summary: "search-type: Search for ExplanationOfBenefit instances" description: This is a search type parameters: - name: care-team in: query description: Member of the CareTeam style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: payee in: query description: The party receiving any payment for the Claim style: simple - name: provider in: query description: The reference to the provider style: simple - name: patient in: query description: The reference to the patient style: simple - name: detail-udi in: query description: UDI associated with a line item detail product or service style: simple - name: claim in: query description: The reference to the claim style: simple - name: enterer in: query description: The party responsible for the entry of the Claim style: simple - name: procedure-udi in: query description: UDI associated with a procedure style: simple - name: item-udi in: query description: UDI associated with a line item product or service style: simple - name: coverage in: query description: The plan under which the claim was adjudicated style: simple - name: identifier in: query description: The business identifier of the Explanation of Benefit style: simple - name: created in: query description: The creation date for the EOB style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounters associated with a billed line item style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: disposition in: query description: The contents of the disposition message style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: subdetail-udi in: query description: UDI associated with a line item detail subdetail product or service style: simple - name: facility in: query description: Facility responsible for the goods and services style: simple - name: status in: query description: Status of the instance style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: payee in: query description: The party receiving any payment for the Claim style: simple - name: provider in: query description: The reference to the provider style: simple - name: patient in: query description: The reference to the patient style: simple - name: detail-udi in: query description: UDI associated with a line item detail product or service style: simple - name: claim in: query description: The reference to the claim style: simple - name: enterer in: query description: The party responsible for the entry of the Claim style: simple - name: procedure-udi in: query description: UDI associated with a procedure style: simple - name: item-udi in: query description: UDI associated with a line item product or service style: simple - name: coverage in: query description: The plan under which the claim was adjudicated style: simple - name: identifier in: query description: The business identifier of the Explanation of Benefit style: simple - name: created in: query description: The creation date for the EOB style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounters associated with a billed line item style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: disposition in: query description: The contents of the disposition message style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: subdetail-udi in: query description: UDI associated with a line item detail subdetail product or service style: simple - name: facility in: query description: Facility responsible for the goods and services style: simple - name: status in: query description: Status of the instance style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExplanationOfBenefit/$validate: get: tags: - ExplanationOfBenefit parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ExplanationOfBenefit requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExplanationOfBenefit/{id}/$validate: get: tags: - ExplanationOfBenefit parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ExplanationOfBenefit parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExplanationOfBenefit/{id}/$meta-delete: post: tags: - ExplanationOfBenefit description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExplanationOfBenefit/{id}/$meta-add: post: tags: - ExplanationOfBenefit description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExplanationOfBenefit/$meta: get: tags: - ExplanationOfBenefit 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ExplanationOfBenefit 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExplanationOfBenefit/{id}/$meta: get: tags: - ExplanationOfBenefit description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ExplanationOfBenefit description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExplanationOfBenefit/$expunge: post: tags: - ExplanationOfBenefit requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ExplanationOfBenefit/{id}/$expunge: post: tags: - ExplanationOfBenefit parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: sex in: query description: A search by a sex code of a family member style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: relationship in: query description: A search by a relationship type style: simple - name: status in: query description: partial | completed | entered-in-error | health-unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: sex in: query description: A search by a sex code of a family member style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: relationship in: query description: A search by a relationship type style: simple - name: status in: query description: partial | completed | entered-in-error | health-unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /FamilyMemberHistory/$validate: get: tags: - FamilyMemberHistory parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - FamilyMemberHistory requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /FamilyMemberHistory/{id}/$validate: get: tags: - FamilyMemberHistory parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - FamilyMemberHistory parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /FamilyMemberHistory/{id}/$meta-delete: post: tags: - FamilyMemberHistory description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /FamilyMemberHistory/{id}/$meta-add: post: tags: - FamilyMemberHistory description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /FamilyMemberHistory/$meta: get: tags: - FamilyMemberHistory 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - FamilyMemberHistory 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /FamilyMemberHistory/{id}/$meta: get: tags: - FamilyMemberHistory description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - FamilyMemberHistory description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /FamilyMemberHistory/$expunge: post: tags: - FamilyMemberHistory requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /FamilyMemberHistory/{id}/$expunge: post: tags: - FamilyMemberHistory parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: identifier in: query description: Business identifier style: simple - name: author in: query description: Flag creator style: simple - name: subject in: query description: The identity of a subject to list flags for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: identifier in: query description: Business identifier style: simple - name: author in: query description: Flag creator style: simple - name: subject in: query description: The identity of a subject to list flags for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Flag/$validate: get: tags: - Flag parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Flag requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Flag/{id}/$validate: get: tags: - Flag parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Flag parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Flag/{id}/$meta-delete: post: tags: - Flag description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Flag/{id}/$meta-add: post: tags: - Flag description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Flag/$meta: get: tags: - Flag 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Flag 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Flag/{id}/$meta: get: tags: - Flag description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Flag description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Flag/$expunge: post: tags: - Flag requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Flag/{id}/$expunge: post: tags: - Flag parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: subject in: query description: Who this goal is intended for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: start-date in: query description: When goal pursuit begins style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: lifecycle-status in: query description: proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: achievement-status in: query description: in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: "E.g. Treatment, dietary, behavioral, etc." style: simple - name: target-date in: query description: Reach goal on or before style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: subject in: query description: Who this goal is intended for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: start-date in: query description: When goal pursuit begins style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: lifecycle-status in: query description: proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: achievement-status in: query description: in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: "E.g. Treatment, dietary, behavioral, etc." style: simple - name: target-date in: query description: Reach goal on or before style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Goal/$validate: get: tags: - Goal parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Goal requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Goal/{id}/$validate: get: tags: - Goal parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Goal parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Goal/{id}/$meta-delete: post: tags: - Goal description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Goal/{id}/$meta-add: post: tags: - Goal description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Goal/$meta: get: tags: - Goal 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Goal 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Goal/{id}/$meta: get: tags: - Goal description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Goal description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Goal/$expunge: post: tags: - Goal requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Goal/{id}/$expunge: post: tags: - Goal parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: start in: query description: Type of resource at which the graph starts style: simple - name: description in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: context-quantity in: query description: "Multiple Resources: \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" style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: context in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: context-type-quantity in: query description: "Multiple Resources: \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" style: simple - 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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: start in: query description: Type of resource at which the graph starts style: simple - name: description in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: context-quantity in: query description: "Multiple Resources: \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" style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: context in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: context-type-quantity in: query description: "Multiple Resources: \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" style: simple - 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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GraphDefinition/$validate: get: tags: - GraphDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - GraphDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GraphDefinition/{id}/$validate: get: tags: - GraphDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - GraphDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GraphDefinition/{id}/$meta-delete: post: tags: - GraphDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GraphDefinition/{id}/$meta-add: post: tags: - GraphDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GraphDefinition/$meta: get: tags: - GraphDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - GraphDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GraphDefinition/{id}/$meta: get: tags: - GraphDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - GraphDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GraphDefinition/$expunge: post: tags: - GraphDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GraphDefinition/{id}/$expunge: post: tags: - GraphDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Group: get: tags: - Group summary: "search-type: Search for Group instances" description: This is a search type parameters: - name: actual in: query description: Descriptive or actual style: simple - name: identifier in: query description: Unique id style: simple - name: managing-entity in: query description: Entity that is the custodian of the Group's definition style: simple - name: code in: query description: The kind of resources contained style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: The type of resources the group contains style: simple - name: characteristic in: query description: Kind of characteristic style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: characteristic-value in: query description: A composite of both characteristic and value style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: member in: query description: Reference to the group member style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: exclude in: query description: Group includes or excludes style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: value in: query description: Value held by characteristic style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: Unique id style: simple - name: managing-entity in: query description: Entity that is the custodian of the Group's definition style: simple - name: code in: query description: The kind of resources contained style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: The type of resources the group contains style: simple - name: characteristic in: query description: Kind of characteristic style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: characteristic-value in: query description: A composite of both characteristic and value style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: member in: query description: Reference to the group member style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: exclude in: query description: Group includes or excludes style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: value in: query description: Value held by characteristic style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Group/$validate: get: tags: - Group parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Group requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Group/{id}/$validate: get: tags: - Group parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Group parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Group/{id}/$meta-delete: post: tags: - Group description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Group/{id}/$meta-add: post: tags: - Group description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Group/$meta: get: tags: - Group 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Group 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Group/{id}/$meta: get: tags: - Group description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Group description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Group/$expunge: post: tags: - Group requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Group/{id}/$expunge: post: tags: - Group parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GuidanceResponse: get: tags: - GuidanceResponse summary: "search-type: Search for GuidanceResponse instances" description: This is a search type parameters: - name: identifier in: query description: The identifier of the guidance response style: simple - name: request in: query description: The identifier of the request associated with the response style: simple - name: subject in: query description: The subject that the guidance response is about style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The identity of a patient to search for guidance response results style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: request in: query description: The identifier of the request associated with the response style: simple - name: subject in: query description: The subject that the guidance response is about style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The identity of a patient to search for guidance response results style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GuidanceResponse/$validate: get: tags: - GuidanceResponse parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - GuidanceResponse requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GuidanceResponse/{id}/$validate: get: tags: - GuidanceResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - GuidanceResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GuidanceResponse/{id}/$meta-delete: post: tags: - GuidanceResponse description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GuidanceResponse/{id}/$meta-add: post: tags: - GuidanceResponse description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GuidanceResponse/$meta: get: tags: - GuidanceResponse 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - GuidanceResponse 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GuidanceResponse/{id}/$meta: get: tags: - GuidanceResponse description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - GuidanceResponse description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GuidanceResponse/$expunge: post: tags: - GuidanceResponse requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /GuidanceResponse/{id}/$expunge: post: tags: - GuidanceResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService: get: tags: - HealthcareService summary: "search-type: Search for HealthcareService instances" description: This is a search type parameters: - name: identifier in: query description: External identifiers for this item style: simple - name: specialty in: query description: The specialty of the service provided by this healthcare service style: simple - name: service-category in: query description: Service Category of the Healthcare Service style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: service-type in: query description: The type of service provided by this healthcare service style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: The Healthcare Service is currently marked as active style: simple - name: program in: query description: One of the Programs supported by this HealthcareService style: simple - name: characteristic in: query description: One of the HealthcareService's characteristics style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to electronic services operated for the healthcare service style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: coverage-area in: query description: Location(s) service is intended for/available to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The organization that provides this Healthcare Service style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: A portion of the Healthcare service name style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: The location of the Healthcare Service style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: specialty in: query description: The specialty of the service provided by this healthcare service style: simple - name: service-category in: query description: Service Category of the Healthcare Service style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: service-type in: query description: The type of service provided by this healthcare service style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: The Healthcare Service is currently marked as active style: simple - name: program in: query description: One of the Programs supported by this HealthcareService style: simple - name: characteristic in: query description: One of the HealthcareService's characteristics style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to electronic services operated for the healthcare service style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: coverage-area in: query description: Location(s) service is intended for/available to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The organization that provides this Healthcare Service style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: A portion of the Healthcare service name style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: The location of the Healthcare Service style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService/$validate: get: tags: - HealthcareService parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - HealthcareService requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService/{id}/$validate: get: tags: - HealthcareService parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - HealthcareService parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService/{id}/$meta-delete: post: tags: - HealthcareService description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService/{id}/$meta-add: post: tags: - HealthcareService description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService/$meta: get: tags: - HealthcareService 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - HealthcareService 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService/{id}/$meta: get: tags: - HealthcareService description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - HealthcareService description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService/$expunge: post: tags: - HealthcareService requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /HealthcareService/{id}/$expunge: post: tags: - HealthcareService parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImagingStudy: get: tags: - ImagingStudy summary: "search-type: Search for ImagingStudy instances" description: This is a search type parameters: - name: reason in: query description: The reason for the study style: simple - name: dicom-class in: query description: The type of the instance style: simple - name: instance in: query description: SOP Instance UID for an instance style: simple - name: modality in: query description: The modality of the series style: simple - name: subject in: query description: Who the study is about style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: endpoint in: query description: The endpoint for the study or series style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: bodysite in: query description: The body site studied style: simple - name: performer in: query description: The person who performed the study style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: interpreter in: query description: Who interpreted the images style: simple - name: started in: query description: When the study was started style: simple - name: encounter in: query description: The context of the study style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: referrer in: query description: The referring physician style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: series in: query description: DICOM Series Instance UID for a series style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: basedon in: query description: The order for the image style: simple - name: status in: query description: The status of the study style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: dicom-class in: query description: The type of the instance style: simple - name: instance in: query description: SOP Instance UID for an instance style: simple - name: modality in: query description: The modality of the series style: simple - name: subject in: query description: Who the study is about style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: endpoint in: query description: The endpoint for the study or series style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: bodysite in: query description: The body site studied style: simple - name: performer in: query description: The person who performed the study style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: interpreter in: query description: Who interpreted the images style: simple - name: started in: query description: When the study was started style: simple - name: encounter in: query description: The context of the study style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: referrer in: query description: The referring physician style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: series in: query description: DICOM Series Instance UID for a series style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: basedon in: query description: The order for the image style: simple - name: status in: query description: The status of the study style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImagingStudy/$validate: get: tags: - ImagingStudy parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImagingStudy requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImagingStudy/{id}/$validate: get: tags: - ImagingStudy parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImagingStudy parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImagingStudy/{id}/$meta-delete: post: tags: - ImagingStudy description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImagingStudy/{id}/$meta-add: post: tags: - ImagingStudy description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImagingStudy/$meta: get: tags: - ImagingStudy 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImagingStudy 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImagingStudy/{id}/$meta: get: tags: - ImagingStudy description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImagingStudy description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImagingStudy/$expunge: post: tags: - ImagingStudy requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImagingStudy/{id}/$expunge: post: tags: - ImagingStudy parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: lot-number in: query description: Vaccine Lot Number style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: status-reason in: query description: Reason why the vaccine was not administered style: simple - name: reason-code in: query description: Reason why the vaccine was administered style: simple - name: manufacturer in: query description: Vaccine Manufacturer style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: reaction-date in: query description: When reaction started style: simple - 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" style: simple - name: performer in: query description: The practitioner or organization who played a role in the vaccination style: simple - name: reaction in: query description: Additional information on reaction style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: target-disease in: query description: The target disease the dose is being administered against style: simple - name: series in: query description: The series being followed by the provider style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: vaccine-code in: query description: Vaccine Product Administered style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: reason-reference in: query description: Why immunization occurred style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: The service delivery location or facility in which the vaccine was / was to be administered style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Immunization event status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: lot-number in: query description: Vaccine Lot Number style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: status-reason in: query description: Reason why the vaccine was not administered style: simple - name: reason-code in: query description: Reason why the vaccine was administered style: simple - name: manufacturer in: query description: Vaccine Manufacturer style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: reaction-date in: query description: When reaction started style: simple - 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" style: simple - name: performer in: query description: The practitioner or organization who played a role in the vaccination style: simple - name: reaction in: query description: Additional information on reaction style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: target-disease in: query description: The target disease the dose is being administered against style: simple - name: series in: query description: The series being followed by the provider style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: vaccine-code in: query description: Vaccine Product Administered style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: reason-reference in: query description: Why immunization occurred style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: The service delivery location or facility in which the vaccine was / was to be administered style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Immunization event status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Immunization/$validate: get: tags: - Immunization parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Immunization requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Immunization/{id}/$validate: get: tags: - Immunization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Immunization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Immunization/{id}/$meta-delete: post: tags: - Immunization description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Immunization/{id}/$meta-add: post: tags: - Immunization description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Immunization/$meta: get: tags: - Immunization 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Immunization 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Immunization/{id}/$meta: get: tags: - Immunization description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Immunization description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Immunization/$expunge: post: tags: - Immunization requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Immunization/{id}/$expunge: post: tags: - Immunization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationEvaluation: get: tags: - ImmunizationEvaluation summary: "search-type: Search for ImmunizationEvaluation instances" description: This is a search type parameters: - name: date in: query description: Date the evaluation was generated style: simple - name: identifier in: query description: ID of the evaluation style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: dose-status in: query description: The status of the dose relative to published recommendations style: simple - name: immunization-event in: query description: The vaccine administration event being evaluated style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: target-disease in: query description: The vaccine preventable disease being evaluated against style: simple - name: patient in: query description: The patient being evaluated style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Immunization evaluation status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: ID of the evaluation style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: dose-status in: query description: The status of the dose relative to published recommendations style: simple - name: immunization-event in: query description: The vaccine administration event being evaluated style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: target-disease in: query description: The vaccine preventable disease being evaluated against style: simple - name: patient in: query description: The patient being evaluated style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Immunization evaluation status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationEvaluation/$validate: get: tags: - ImmunizationEvaluation parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImmunizationEvaluation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationEvaluation/{id}/$validate: get: tags: - ImmunizationEvaluation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImmunizationEvaluation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationEvaluation/{id}/$meta-delete: post: tags: - ImmunizationEvaluation description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationEvaluation/{id}/$meta-add: post: tags: - ImmunizationEvaluation description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationEvaluation/$meta: get: tags: - ImmunizationEvaluation 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImmunizationEvaluation 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationEvaluation/{id}/$meta: get: tags: - ImmunizationEvaluation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImmunizationEvaluation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationEvaluation/$expunge: post: tags: - ImmunizationEvaluation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationEvaluation/{id}/$expunge: post: tags: - ImmunizationEvaluation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationRecommendation: get: tags: - ImmunizationRecommendation summary: "search-type: Search for ImmunizationRecommendation instances" description: This is a search type parameters: - name: date in: query description: Date recommendation(s) created style: simple - name: identifier in: query description: Business identifier style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: vaccine-type in: query description: Vaccine or vaccine group recommendation applies to style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: target-disease in: query description: Disease to be immunized against style: simple - name: patient in: query description: Who this profile is for style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: information in: query description: Patient observations supporting recommendation style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: support in: query description: Past immunizations supporting recommendation style: simple - name: status in: query description: Vaccine recommendation status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: Business identifier style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: vaccine-type in: query description: Vaccine or vaccine group recommendation applies to style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: target-disease in: query description: Disease to be immunized against style: simple - name: patient in: query description: Who this profile is for style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: information in: query description: Patient observations supporting recommendation style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: support in: query description: Past immunizations supporting recommendation style: simple - name: status in: query description: Vaccine recommendation status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationRecommendation/$validate: get: tags: - ImmunizationRecommendation parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImmunizationRecommendation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationRecommendation/{id}/$validate: get: tags: - ImmunizationRecommendation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImmunizationRecommendation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationRecommendation/{id}/$meta-delete: post: tags: - ImmunizationRecommendation description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationRecommendation/{id}/$meta-add: post: tags: - ImmunizationRecommendation description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationRecommendation/$meta: get: tags: - ImmunizationRecommendation 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImmunizationRecommendation 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationRecommendation/{id}/$meta: get: tags: - ImmunizationRecommendation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImmunizationRecommendation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationRecommendation/$expunge: post: tags: - ImmunizationRecommendation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImmunizationRecommendation/{id}/$expunge: post: tags: - ImmunizationRecommendation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: experimental in: query description: "For testing purposes, not real usage" style: simple - name: global in: query description: Profile that all resources must conform to style: simple - name: title in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: depends-on in: query description: Identity of the IG that this depends on style: simple - name: context in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: resource in: query description: Location of the resource style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: experimental in: query description: "For testing purposes, not real usage" style: simple - name: global in: query description: Profile that all resources must conform to style: simple - name: title in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: depends-on in: query description: Identity of the IG that this depends on style: simple - name: context in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: resource in: query description: Location of the resource style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImplementationGuide/$validate: get: tags: - ImplementationGuide parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImplementationGuide requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImplementationGuide/{id}/$validate: get: tags: - ImplementationGuide parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImplementationGuide parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImplementationGuide/{id}/$meta-delete: post: tags: - ImplementationGuide description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImplementationGuide/{id}/$meta-add: post: tags: - ImplementationGuide description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImplementationGuide/$meta: get: tags: - ImplementationGuide 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImplementationGuide 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImplementationGuide/{id}/$meta: get: tags: - ImplementationGuide description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ImplementationGuide description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImplementationGuide/$expunge: post: tags: - ImplementationGuide requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ImplementationGuide/{id}/$expunge: post: tags: - ImplementationGuide parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /InsurancePlan: get: tags: - InsurancePlan summary: "search-type: Search for InsurancePlan instances" description: This is a search type parameters: - name: identifier in: query description: Any identifier for the organization (not the accreditation issuer's identifier) style: simple - name: address in: query description: "A server defined search that may match any of the string fields\ \ in the Address, including line, city, district, state, country, postalCode,\ \ and/or text" style: simple - name: address-state in: query description: A state specified in an address style: simple - name: owned-by in: query description: An organization of which this organization forms a part style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: A code for the type of organization style: simple - name: address-postalcode in: query description: A postal code specified in an address style: simple - name: address-country in: query description: A country specified in an address style: simple - name: administered-by in: query description: Product administrator style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoint style: simple - name: phonetic in: query description: A portion of the organization's name using some kind of phonetic matching algorithm style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: A use code specified in an address style: simple - name: name in: query description: A portion of the organization's name or alias style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: address-city in: query description: A city specified in an address style: simple - name: status in: query description: Is the Organization record active style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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) style: simple - name: address in: query description: "A server defined search that may match any of the string fields\ \ in the Address, including line, city, district, state, country, postalCode,\ \ and/or text" style: simple - name: address-state in: query description: A state specified in an address style: simple - name: owned-by in: query description: An organization of which this organization forms a part style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: A code for the type of organization style: simple - name: address-postalcode in: query description: A postal code specified in an address style: simple - name: address-country in: query description: A country specified in an address style: simple - name: administered-by in: query description: Product administrator style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoint style: simple - name: phonetic in: query description: A portion of the organization's name using some kind of phonetic matching algorithm style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: A use code specified in an address style: simple - name: name in: query description: A portion of the organization's name or alias style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: address-city in: query description: A city specified in an address style: simple - name: status in: query description: Is the Organization record active style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /InsurancePlan/$validate: get: tags: - InsurancePlan parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - InsurancePlan requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /InsurancePlan/{id}/$validate: get: tags: - InsurancePlan parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - InsurancePlan parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /InsurancePlan/{id}/$meta-delete: post: tags: - InsurancePlan description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /InsurancePlan/{id}/$meta-add: post: tags: - InsurancePlan description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /InsurancePlan/$meta: get: tags: - InsurancePlan 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - InsurancePlan 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /InsurancePlan/{id}/$meta: get: tags: - InsurancePlan description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - InsurancePlan description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /InsurancePlan/$expunge: post: tags: - InsurancePlan requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /InsurancePlan/{id}/$expunge: post: tags: - InsurancePlan parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Invoice: get: tags: - Invoice summary: "search-type: Search for Invoice instances" description: This is a search type parameters: - name: date in: query description: Invoice date / posting date style: simple - name: identifier in: query description: Business Identifier for item style: simple - name: totalgross in: query description: Gross total of this Invoice style: simple - name: participant-role in: query description: Type of involvement in creation of this Invoice style: simple - name: subject in: query description: Recipient(s) of goods and services style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: Type of Invoice style: simple - name: issuer in: query description: Issuing Organization of Invoice style: simple - name: participant in: query description: Individual who was involved style: simple - name: totalnet in: query description: Net total of this Invoice style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: Recipient(s) of goods and services style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: recipient in: query description: Recipient of this invoice style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: account in: query description: Account that is being balanced style: simple - name: status in: query description: draft | issued | balanced | cancelled | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: Business Identifier for item style: simple - name: totalgross in: query description: Gross total of this Invoice style: simple - name: participant-role in: query description: Type of involvement in creation of this Invoice style: simple - name: subject in: query description: Recipient(s) of goods and services style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: Type of Invoice style: simple - name: issuer in: query description: Issuing Organization of Invoice style: simple - name: participant in: query description: Individual who was involved style: simple - name: totalnet in: query description: Net total of this Invoice style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: Recipient(s) of goods and services style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: recipient in: query description: Recipient of this invoice style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: account in: query description: Account that is being balanced style: simple - name: status in: query description: draft | issued | balanced | cancelled | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Invoice/$validate: get: tags: - Invoice parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Invoice requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Invoice/{id}/$validate: get: tags: - Invoice parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Invoice parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Invoice/{id}/$meta-delete: post: tags: - Invoice description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Invoice/{id}/$meta-add: post: tags: - Invoice description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Invoice/$meta: get: tags: - Invoice 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Invoice 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Invoice/{id}/$meta: get: tags: - Invoice description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Invoice description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Invoice/$expunge: post: tags: - Invoice requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Invoice/{id}/$expunge: post: tags: - Invoice parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Library: get: tags: - Library summary: "search-type: Search for Library instances" description: This is a search type parameters: - name: date in: query description: The library publication date style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the library style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the library style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the library style: simple - name: context-type in: query description: A type of use context assigned to the library style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the library style: simple - name: type in: query description: "The type of the library (e.g. logic-library, model-definition,\ \ asset-collection, module-definition)" style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the library style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the library is intended to be in use style: simple - name: context in: query description: A use context assigned to the library style: simple - name: content-type in: query description: The type of content in the library (e.g. text/cql) style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the library style: simple - name: identifier in: query description: External identifier for the library style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the library style: simple - name: url in: query description: The uri that identifies the library style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the library style: simple - name: publisher in: query description: Name of the publisher of the library style: simple - name: topic in: query description: Topics associated with the module style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the library style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the library style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the library style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the library style: simple - name: context-type in: query description: A type of use context assigned to the library style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the library style: simple - name: type in: query description: "The type of the library (e.g. logic-library, model-definition,\ \ asset-collection, module-definition)" style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the library style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the library is intended to be in use style: simple - name: context in: query description: A use context assigned to the library style: simple - name: content-type in: query description: The type of content in the library (e.g. text/cql) style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the library style: simple - name: identifier in: query description: External identifier for the library style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the library style: simple - name: url in: query description: The uri that identifies the library style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the library style: simple - name: publisher in: query description: Name of the publisher of the library style: simple - name: topic in: query description: Topics associated with the module style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the library style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Library/$validate: get: tags: - Library parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Library requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Library/{id}/$validate: get: tags: - Library parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Library parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Library/{id}/$meta-delete: post: tags: - Library description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Library/{id}/$meta-add: post: tags: - Library description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Library/$meta: get: tags: - Library 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Library 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Library/{id}/$meta: get: tags: - Library description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Library description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Library/$expunge: post: tags: - Library requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Library/{id}/$expunge: post: tags: - Library parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Linkage: get: tags: - Linkage summary: "search-type: Search for Linkage instances" description: This is a search type parameters: - name: item in: query description: Matches on any item in the Linkage style: simple - name: author in: query description: Author of the Linkage style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: source in: query description: Matches on any item in the Linkage with a type of 'source' style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Linkage/_search: get: tags: - Linkage summary: "search-type: Search for Linkage instances" description: This is a search type parameters: - name: item in: query description: Matches on any item in the Linkage style: simple - name: author in: query description: Author of the Linkage style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: source in: query description: Matches on any item in the Linkage with a type of 'source' style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Linkage/$validate: get: tags: - Linkage parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Linkage requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Linkage/{id}/$validate: get: tags: - Linkage parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Linkage parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Linkage/{id}/$meta-delete: post: tags: - Linkage description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Linkage/{id}/$meta-add: post: tags: - Linkage description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Linkage/$meta: get: tags: - Linkage 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Linkage 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Linkage/{id}/$meta: get: tags: - Linkage description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Linkage description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Linkage/$expunge: post: tags: - Linkage requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Linkage/{id}/$expunge: post: tags: - Linkage parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: empty-reason in: query description: Why list is empty style: simple - name: item in: query description: Actual entry style: simple - name: code in: query description: "Multiple Resources: \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" style: simple - name: notes in: query description: The annotation - text content (as markdown) style: simple - name: subject in: query description: If all resources have the same subject style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: source in: query description: Who and/or what defined the list contents (aka Author) style: simple - name: title in: query description: Descriptive name for the list style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: current | retired | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: empty-reason in: query description: Why list is empty style: simple - name: item in: query description: Actual entry style: simple - name: code in: query description: "Multiple Resources: \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" style: simple - name: notes in: query description: The annotation - text content (as markdown) style: simple - name: subject in: query description: If all resources have the same subject style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: source in: query description: Who and/or what defined the list contents (aka Author) style: simple - name: title in: query description: Descriptive name for the list style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: current | retired | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /List/$validate: get: tags: - List parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - List requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /List/{id}/$validate: get: tags: - List parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - List parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /List/{id}/$meta-delete: post: tags: - List description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /List/{id}/$meta-add: post: tags: - List description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /List/$meta: get: tags: - List 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - List 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /List/{id}/$meta: get: tags: - List description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - List description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /List/$expunge: post: tags: - List requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /List/{id}/$expunge: post: tags: - List parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location: get: tags: - Location summary: "search-type: Search for Location instances" description: This is a search type parameters: - name: address-state in: query description: A state specified in an address style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: operational-status in: query description: "Searches for locations (typically bed/room) that have an operational\ \ status (e.g. contaminated, housekeeping)" style: simple - name: type in: query description: A code for the type of location style: simple - name: address-country in: query description: A country specified in an address style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the location style: simple - name: near in: query description: |- Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). 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 style: simple - name: address-city in: query description: A city specified in an address style: simple - name: identifier in: query description: An identifier for the location style: simple - name: partof in: query description: A location of which this location is a part style: simple - name: address in: query description: A (part of the) address of the location style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: address-postalcode in: query description: A postal code specified in an address style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: Searches for locations that are managed by the provided organization style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: A use code specified in an address style: simple - name: name in: query description: A portion of the location's name or alias style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Searches for locations with a specific kind of status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/_search: get: tags: - Location summary: "search-type: Search for Location instances" description: This is a search type parameters: - name: address-state in: query description: A state specified in an address style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: operational-status in: query description: "Searches for locations (typically bed/room) that have an operational\ \ status (e.g. contaminated, housekeeping)" style: simple - name: type in: query description: A code for the type of location style: simple - name: address-country in: query description: A country specified in an address style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the location style: simple - name: near in: query description: |- Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). 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 style: simple - name: address-city in: query description: A city specified in an address style: simple - name: identifier in: query description: An identifier for the location style: simple - name: partof in: query description: A location of which this location is a part style: simple - name: address in: query description: A (part of the) address of the location style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: address-postalcode in: query description: A postal code specified in an address style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: Searches for locations that are managed by the provided organization style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: A use code specified in an address style: simple - name: name in: query description: A portion of the location's name or alias style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Searches for locations with a specific kind of status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/$validate: get: tags: - Location parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Location requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/{id}/$validate: get: tags: - Location parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Location parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/{id}/$meta-delete: post: tags: - Location description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/{id}/$meta-add: post: tags: - Location description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/$meta: get: tags: - Location 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Location 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/{id}/$meta: get: tags: - Location description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Location description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/$expunge: post: tags: - Location requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/{id}/$expunge: post: tags: - Location parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Measure: get: tags: - Measure summary: "search-type: Search for Measure instances" description: This is a search type parameters: - name: date in: query description: The measure publication date style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the measure style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the measure style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the measure style: simple - name: context-type in: query description: A type of use context assigned to the measure style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the measure style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the measure style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the measure is intended to be in use style: simple - name: context in: query description: A use context assigned to the measure style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the measure style: simple - name: identifier in: query description: External identifier for the measure style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the measure style: simple - name: url in: query description: The uri that identifies the measure style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the measure style: simple - name: publisher in: query description: Name of the publisher of the measure style: simple - name: topic in: query description: Topics associated with the measure style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the measure style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the measure style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the measure style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the measure style: simple - name: context-type in: query description: A type of use context assigned to the measure style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the measure style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the measure style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the measure is intended to be in use style: simple - name: context in: query description: A use context assigned to the measure style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the measure style: simple - name: identifier in: query description: External identifier for the measure style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the measure style: simple - name: url in: query description: The uri that identifies the measure style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the measure style: simple - name: publisher in: query description: Name of the publisher of the measure style: simple - name: topic in: query description: Topics associated with the measure style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the measure style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Measure/$validate: get: tags: - Measure parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Measure requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Measure/{id}/$validate: get: tags: - Measure parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Measure parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Measure/{id}/$meta-delete: post: tags: - Measure description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Measure/{id}/$meta-add: post: tags: - Measure description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Measure/$meta: get: tags: - Measure 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Measure 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Measure/{id}/$meta: get: tags: - Measure description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Measure description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Measure/$expunge: post: tags: - Measure requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Measure/{id}/$expunge: post: tags: - Measure parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MeasureReport: get: tags: - MeasureReport summary: "search-type: Search for MeasureReport instances" description: This is a search type parameters: - name: date in: query description: The date of the measure report style: simple - name: identifier in: query description: External identifier of the measure report to be returned style: simple - name: period in: query description: The period of the measure report style: simple - name: subject in: query description: The identity of a subject to search for individual measure report results for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: reporter in: query description: The reporter to return measure report results for style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: measure in: query description: The measure to return measure report results for style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The identity of a patient to search for individual measure report results for style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: evaluated-resource in: query description: An evaluated resource referenced by the measure report style: simple - name: status in: query description: The status of the measure report style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: External identifier of the measure report to be returned style: simple - name: period in: query description: The period of the measure report style: simple - name: subject in: query description: The identity of a subject to search for individual measure report results for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: reporter in: query description: The reporter to return measure report results for style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: measure in: query description: The measure to return measure report results for style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The identity of a patient to search for individual measure report results for style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: evaluated-resource in: query description: An evaluated resource referenced by the measure report style: simple - name: status in: query description: The status of the measure report style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MeasureReport/$validate: get: tags: - MeasureReport parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MeasureReport requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MeasureReport/{id}/$validate: get: tags: - MeasureReport parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MeasureReport parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MeasureReport/{id}/$meta-delete: post: tags: - MeasureReport description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MeasureReport/{id}/$meta-add: post: tags: - MeasureReport description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MeasureReport/$meta: get: tags: - MeasureReport 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MeasureReport 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MeasureReport/{id}/$meta: get: tags: - MeasureReport description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MeasureReport description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MeasureReport/$expunge: post: tags: - MeasureReport requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MeasureReport/{id}/$expunge: post: tags: - MeasureReport parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: modality in: query description: The type of acquisition equipment/process style: simple - name: created in: query description: When Media was collected style: simple - name: subject in: query description: Who/What this Media is a record of style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounter associated with media style: simple - name: type in: query description: "Classification of media as image, video, or audio" style: simple - name: operator in: query description: The person who generated the image style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: site in: query description: Observed body part style: simple - name: view in: query description: "Imaging view, e.g. Lateral or Antero-posterior" style: simple - name: based-on in: query description: Procedure that caused this media to be created style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: Who/What this Media is a record of style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: device in: query description: Observing Device style: simple - name: status in: query description: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: modality in: query description: The type of acquisition equipment/process style: simple - name: created in: query description: When Media was collected style: simple - name: subject in: query description: Who/What this Media is a record of style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Encounter associated with media style: simple - name: type in: query description: "Classification of media as image, video, or audio" style: simple - name: operator in: query description: The person who generated the image style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: site in: query description: Observed body part style: simple - name: view in: query description: "Imaging view, e.g. Lateral or Antero-posterior" style: simple - name: based-on in: query description: Procedure that caused this media to be created style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: Who/What this Media is a record of style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: device in: query description: Observing Device style: simple - name: status in: query description: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Media/$validate: get: tags: - Media parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Media requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Media/{id}/$validate: get: tags: - Media parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Media parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Media/{id}/$meta-delete: post: tags: - Media description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Media/{id}/$meta-add: post: tags: - Media description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Media/$meta: get: tags: - Media 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Media 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Media/{id}/$meta: get: tags: - Media description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Media description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Media/$expunge: post: tags: - Media requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Media/{id}/$expunge: post: tags: - Media parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Medication: get: tags: - Medication summary: "search-type: Search for Medication instances" description: This is a search type parameters: - name: identifier in: query description: Returns medications with this external identifier style: simple - name: code in: query description: "Multiple Resources: \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" style: simple - name: ingredient in: query description: Returns medications for this ingredient reference style: simple - name: lot-number in: query description: Returns medications in a batch with this lot number style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: manufacturer in: query description: Returns medications made or sold for this manufacturer style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: ingredient-code in: query description: Returns medications for this ingredient code style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: form in: query description: Returns medications for a specific dose form style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: expiration-date in: query description: Returns medications in a batch with this expiration date style: simple - name: status in: query description: Returns medications for this status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - 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" style: simple - name: ingredient in: query description: Returns medications for this ingredient reference style: simple - name: lot-number in: query description: Returns medications in a batch with this lot number style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: manufacturer in: query description: Returns medications made or sold for this manufacturer style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: ingredient-code in: query description: Returns medications for this ingredient code style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: form in: query description: Returns medications for a specific dose form style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: expiration-date in: query description: Returns medications in a batch with this expiration date style: simple - name: status in: query description: Returns medications for this status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Medication/$validate: get: tags: - Medication parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Medication requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Medication/{id}/$validate: get: tags: - Medication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Medication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Medication/{id}/$meta-delete: post: tags: - Medication description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Medication/{id}/$meta-add: post: tags: - Medication description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Medication/$meta: get: tags: - Medication 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Medication 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Medication/{id}/$meta: get: tags: - Medication description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Medication description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Medication/$expunge: post: tags: - Medication requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Medication/{id}/$expunge: post: tags: - Medication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: request in: query description: The identity of a request to list administrations from style: simple - name: code in: query description: "Multiple Resources: \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" style: simple - name: performer in: query description: The identity of the individual who administered the medication style: simple - name: subject in: query description: The identity of the individual or group to list administrations for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: medication in: query description: "Multiple Resources: \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" style: simple - name: reason-given in: query description: Reasons for administering the medication style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: effective-time in: query description: Date administration happened (or did not happen) style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: context in: query description: Return administrations that share this encounter or episode of care style: simple - name: reason-not-given in: query description: Reasons for not administering the medication style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: device in: query description: Return administrations with this administration device identity style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: request in: query description: The identity of a request to list administrations from style: simple - name: code in: query description: "Multiple Resources: \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" style: simple - name: performer in: query description: The identity of the individual who administered the medication style: simple - name: subject in: query description: The identity of the individual or group to list administrations for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: medication in: query description: "Multiple Resources: \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" style: simple - name: reason-given in: query description: Reasons for administering the medication style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: effective-time in: query description: Date administration happened (or did not happen) style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: context in: query description: Return administrations that share this encounter or episode of care style: simple - name: reason-not-given in: query description: Reasons for not administering the medication style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: device in: query description: Return administrations with this administration device identity style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationAdministration/$validate: get: tags: - MedicationAdministration parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationAdministration requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationAdministration/{id}/$validate: get: tags: - MedicationAdministration parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationAdministration parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationAdministration/{id}/$meta-delete: post: tags: - MedicationAdministration description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationAdministration/{id}/$meta-add: post: tags: - MedicationAdministration description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationAdministration/$meta: get: tags: - MedicationAdministration 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationAdministration 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationAdministration/{id}/$meta: get: tags: - MedicationAdministration description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationAdministration description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationAdministration/$expunge: post: tags: - MedicationAdministration requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationAdministration/{id}/$expunge: post: tags: - MedicationAdministration parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationDispense: get: tags: - MedicationDispense summary: "search-type: Search for MedicationDispense instances" description: This is a search type parameters: - name: code in: query description: "Multiple Resources: \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" style: simple - name: subject in: query description: The identity of a patient for whom to list dispenses style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: destination in: query description: Returns dispenses that should be sent to a specific destination style: simple - name: type in: query description: Returns dispenses of a specific type style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: context in: query description: Returns dispenses with a specific context (episode or episode of care) style: simple - 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" style: simple - name: performer in: query description: Returns dispenses performed by a specific individual style: simple - name: receiver in: query description: The identity of a receiver to list dispenses for style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: medication in: query description: "Multiple Resources: \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" style: simple - name: responsibleparty in: query description: Returns dispenses with the specified responsible party style: simple - name: whenhandedover in: query description: Returns dispenses handed over on this date style: simple - name: whenprepared in: query description: Returns dispenses prepared on this date style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: prescription in: query description: "Multiple Resources: \r\n\r\n* [MedicationDispense](medicationdispense.html):\ \ The identity of a prescription to list dispenses from" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationDispense/_search: get: tags: - MedicationDispense summary: "search-type: Search for MedicationDispense instances" description: This is a search type parameters: - 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" style: simple - name: subject in: query description: The identity of a patient for whom to list dispenses style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: destination in: query description: Returns dispenses that should be sent to a specific destination style: simple - name: type in: query description: Returns dispenses of a specific type style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: context in: query description: Returns dispenses with a specific context (episode or episode of care) style: simple - 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" style: simple - name: performer in: query description: Returns dispenses performed by a specific individual style: simple - name: receiver in: query description: The identity of a receiver to list dispenses for style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: medication in: query description: "Multiple Resources: \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" style: simple - name: responsibleparty in: query description: Returns dispenses with the specified responsible party style: simple - name: whenhandedover in: query description: Returns dispenses handed over on this date style: simple - name: whenprepared in: query description: Returns dispenses prepared on this date style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: prescription in: query description: "Multiple Resources: \r\n\r\n* [MedicationDispense](medicationdispense.html):\ \ The identity of a prescription to list dispenses from" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationDispense/$validate: get: tags: - MedicationDispense parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationDispense requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationDispense/{id}/$validate: get: tags: - MedicationDispense parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationDispense parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationDispense/{id}/$meta-delete: post: tags: - MedicationDispense description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationDispense/{id}/$meta-add: post: tags: - MedicationDispense description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationDispense/$meta: get: tags: - MedicationDispense 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationDispense 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationDispense/{id}/$meta: get: tags: - MedicationDispense description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationDispense description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationDispense/$expunge: post: tags: - MedicationDispense requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationDispense/{id}/$expunge: post: tags: - MedicationDispense parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge: get: tags: - MedicationKnowledge summary: "search-type: Search for MedicationKnowledge instances" description: This is a search type parameters: - name: code in: query description: Code that identifies this medication style: simple - name: ingredient in: query description: Medication(s) or substance(s) contained in the medication style: simple - name: doseform in: query description: powder | tablets | capsule + style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: classification-type in: query description: "The type of category for the medication (for example, therapeutic\ \ classification, therapeutic sub-classification)" style: simple - name: monograph-type in: query description: The category of medication document style: simple - name: classification in: query description: Specific category assigned to the medication style: simple - name: manufacturer in: query description: Manufacturer of the item style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: ingredient-code in: query description: Medication(s) or substance(s) contained in the medication style: simple - name: source-cost in: query description: The source or owner for the price information style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: monitoring-program-name in: query description: Name of the reviewing program style: simple - name: monograph in: query description: Associated documentation about the medication style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: monitoring-program-type in: query description: Type of program under which the medication is monitored style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: active | inactive | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: ingredient in: query description: Medication(s) or substance(s) contained in the medication style: simple - name: doseform in: query description: powder | tablets | capsule + style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: classification-type in: query description: "The type of category for the medication (for example, therapeutic\ \ classification, therapeutic sub-classification)" style: simple - name: monograph-type in: query description: The category of medication document style: simple - name: classification in: query description: Specific category assigned to the medication style: simple - name: manufacturer in: query description: Manufacturer of the item style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: ingredient-code in: query description: Medication(s) or substance(s) contained in the medication style: simple - name: source-cost in: query description: The source or owner for the price information style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: monitoring-program-name in: query description: Name of the reviewing program style: simple - name: monograph in: query description: Associated documentation about the medication style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: monitoring-program-type in: query description: Type of program under which the medication is monitored style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: active | inactive | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge/$validate: get: tags: - MedicationKnowledge parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationKnowledge requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge/{id}/$validate: get: tags: - MedicationKnowledge parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationKnowledge parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge/{id}/$meta-delete: post: tags: - MedicationKnowledge description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge/{id}/$meta-add: post: tags: - MedicationKnowledge description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge/$meta: get: tags: - MedicationKnowledge 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationKnowledge 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge/{id}/$meta: get: tags: - MedicationKnowledge description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationKnowledge description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge/$expunge: post: tags: - MedicationKnowledge requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationKnowledge/{id}/$expunge: post: tags: - MedicationKnowledge parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: authoredon in: query description: Return prescriptions written on this date style: simple - name: subject in: query description: The identity of a patient to list orders for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: intended-performer in: query description: Returns the intended performer of the administration of the medication request style: simple - name: intended-performertype in: query description: Returns requests for a specific type of performer style: simple - name: requester in: query description: Returns prescriptions prescribed by this prescriber style: simple - name: identifier in: query description: "Multiple Resources: \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" style: simple - name: intended-dispenser in: query description: Returns prescriptions intended to be dispensed by this Organization style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - name: encounter in: query description: "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html):\ \ Return prescriptions with this encounter identifier" style: simple - name: priority in: query description: Returns prescriptions with different priorities style: simple - name: intent in: query description: Returns prescriptions with different intents style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Returns prescriptions with different categories style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: authoredon in: query description: Return prescriptions written on this date style: simple - name: subject in: query description: The identity of a patient to list orders for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: intended-performer in: query description: Returns the intended performer of the administration of the medication request style: simple - name: intended-performertype in: query description: Returns requests for a specific type of performer style: simple - name: requester in: query description: Returns prescriptions prescribed by this prescriber style: simple - name: identifier in: query description: "Multiple Resources: \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" style: simple - name: intended-dispenser in: query description: Returns prescriptions intended to be dispensed by this Organization style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - name: encounter in: query description: "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html):\ \ Return prescriptions with this encounter identifier" style: simple - name: priority in: query description: Returns prescriptions with different priorities style: simple - name: intent in: query description: Returns prescriptions with different intents style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Returns prescriptions with different categories style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationRequest/$validate: get: tags: - MedicationRequest parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationRequest/{id}/$validate: get: tags: - MedicationRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationRequest/{id}/$meta-delete: post: tags: - MedicationRequest description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationRequest/{id}/$meta-add: post: tags: - MedicationRequest description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationRequest/$meta: get: tags: - MedicationRequest 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationRequest 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationRequest/{id}/$meta: get: tags: - MedicationRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationRequest/$expunge: post: tags: - MedicationRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationRequest/{id}/$expunge: post: tags: - MedicationRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: subject in: query description: "The identity of a patient, animal or group to list statements\ \ for" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: medication in: query description: "Multiple Resources: \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" style: simple - name: part-of in: query description: Returns statements that are part of another event. style: simple - name: source in: query description: Who or where the information in the statement came from style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: effective in: query description: Date when patient was taking (or not taking) the medication style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: context in: query description: Returns statements for a specific context (episode or episode of Care). style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Returns statements of this category of medicationstatement style: simple - 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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: subject in: query description: "The identity of a patient, animal or group to list statements\ \ for" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: medication in: query description: "Multiple Resources: \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" style: simple - name: part-of in: query description: Returns statements that are part of another event. style: simple - name: source in: query description: Who or where the information in the statement came from style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: effective in: query description: Date when patient was taking (or not taking) the medication style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: context in: query description: Returns statements for a specific context (episode or episode of Care). style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Returns statements of this category of medicationstatement style: simple - 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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationStatement/$validate: get: tags: - MedicationStatement parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationStatement requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationStatement/{id}/$validate: get: tags: - MedicationStatement parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationStatement parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationStatement/{id}/$meta-delete: post: tags: - MedicationStatement description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationStatement/{id}/$meta-add: post: tags: - MedicationStatement description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationStatement/$meta: get: tags: - MedicationStatement 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationStatement 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationStatement/{id}/$meta: get: tags: - MedicationStatement description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicationStatement description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationStatement/$expunge: post: tags: - MedicationStatement requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicationStatement/{id}/$expunge: post: tags: - MedicationStatement parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProduct: get: tags: - MedicinalProduct summary: "search-type: Search for MedicinalProduct instances" description: This is a search type parameters: - name: identifier in: query description: Business identifier for this product. Could be an MPID style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: name-language in: query description: Language code for this name style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: The full product name style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProduct/_search: get: tags: - MedicinalProduct summary: "search-type: Search for MedicinalProduct instances" description: This is a search type parameters: - name: identifier in: query description: Business identifier for this product. Could be an MPID style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: name-language in: query description: Language code for this name style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: The full product name style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProduct/$validate: get: tags: - MedicinalProduct parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProduct requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProduct/{id}/$validate: get: tags: - MedicinalProduct parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProduct parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProduct/{id}/$meta-delete: post: tags: - MedicinalProduct description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProduct/{id}/$meta-add: post: tags: - MedicinalProduct description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProduct/$meta: get: tags: - MedicinalProduct 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProduct 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProduct/{id}/$meta: get: tags: - MedicinalProduct description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProduct description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProduct/$expunge: post: tags: - MedicinalProduct requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProduct/{id}/$expunge: post: tags: - MedicinalProduct parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: "Business identifier for the marketing authorization, as assigned\ \ by a regulator" style: simple - name: subject in: query description: The medicinal product that is being authorized style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: holder in: query description: Marketing Authorization Holder style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the marketing authorization style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: "Business identifier for the marketing authorization, as assigned\ \ by a regulator" style: simple - name: subject in: query description: The medicinal product that is being authorized style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: holder in: query description: Marketing Authorization Holder style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the marketing authorization style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductAuthorization/$validate: get: tags: - MedicinalProductAuthorization parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductAuthorization requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductAuthorization/{id}/$validate: get: tags: - MedicinalProductAuthorization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductAuthorization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductAuthorization/{id}/$meta-delete: post: tags: - MedicinalProductAuthorization description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductAuthorization/{id}/$meta-add: post: tags: - MedicinalProductAuthorization description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductAuthorization/$meta: get: tags: - MedicinalProductAuthorization 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductAuthorization 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductAuthorization/{id}/$meta: get: tags: - MedicinalProductAuthorization description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductAuthorization description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductAuthorization/$expunge: post: tags: - MedicinalProductAuthorization requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductAuthorization/{id}/$expunge: post: tags: - MedicinalProductAuthorization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductContraindication: get: tags: - MedicinalProductContraindication summary: "search-type: Search for MedicinalProductContraindication instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: subject in: query description: The medication for which this is an contraindication style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductContraindication/_search: get: tags: - MedicinalProductContraindication summary: "search-type: Search for MedicinalProductContraindication instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: subject in: query description: The medication for which this is an contraindication style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductContraindication/$validate: get: tags: - MedicinalProductContraindication parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductContraindication requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductContraindication/{id}/$validate: get: tags: - MedicinalProductContraindication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductContraindication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductContraindication/{id}/$meta-delete: post: tags: - MedicinalProductContraindication description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductContraindication/{id}/$meta-add: post: tags: - MedicinalProductContraindication description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductContraindication/$meta: get: tags: - MedicinalProductContraindication 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductContraindication 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductContraindication/{id}/$meta: get: tags: - MedicinalProductContraindication description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductContraindication description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductContraindication/$expunge: post: tags: - MedicinalProductContraindication requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductContraindication/{id}/$expunge: post: tags: - MedicinalProductContraindication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIndication: get: tags: - MedicinalProductIndication summary: "search-type: Search for MedicinalProductIndication instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: subject in: query description: The medication for which this is an indication style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIndication/_search: get: tags: - MedicinalProductIndication summary: "search-type: Search for MedicinalProductIndication instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: subject in: query description: The medication for which this is an indication style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIndication/$validate: get: tags: - MedicinalProductIndication parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductIndication requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIndication/{id}/$validate: get: tags: - MedicinalProductIndication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductIndication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIndication/{id}/$meta-delete: post: tags: - MedicinalProductIndication description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIndication/{id}/$meta-add: post: tags: - MedicinalProductIndication description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIndication/$meta: get: tags: - MedicinalProductIndication 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductIndication 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIndication/{id}/$meta: get: tags: - MedicinalProductIndication description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductIndication description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIndication/$expunge: post: tags: - MedicinalProductIndication requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIndication/{id}/$expunge: post: tags: - MedicinalProductIndication parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIngredient: get: tags: - MedicinalProductIngredient summary: "search-type: Search for MedicinalProductIngredient instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIngredient/_search: get: tags: - MedicinalProductIngredient summary: "search-type: Search for MedicinalProductIngredient instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIngredient/$validate: get: tags: - MedicinalProductIngredient parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductIngredient requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIngredient/{id}/$validate: get: tags: - MedicinalProductIngredient parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductIngredient parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIngredient/{id}/$meta-delete: post: tags: - MedicinalProductIngredient description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIngredient/{id}/$meta-add: post: tags: - MedicinalProductIngredient description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIngredient/$meta: get: tags: - MedicinalProductIngredient 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductIngredient 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIngredient/{id}/$meta: get: tags: - MedicinalProductIngredient description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductIngredient description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIngredient/$expunge: post: tags: - MedicinalProductIngredient requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductIngredient/{id}/$expunge: post: tags: - MedicinalProductIngredient parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductInteraction: get: tags: - MedicinalProductInteraction summary: "search-type: Search for MedicinalProductInteraction instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: subject in: query description: The medication for which this is an interaction style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductInteraction/_search: get: tags: - MedicinalProductInteraction summary: "search-type: Search for MedicinalProductInteraction instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: subject in: query description: The medication for which this is an interaction style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductInteraction/$validate: get: tags: - MedicinalProductInteraction parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductInteraction requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductInteraction/{id}/$validate: get: tags: - MedicinalProductInteraction parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductInteraction parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductInteraction/{id}/$meta-delete: post: tags: - MedicinalProductInteraction description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductInteraction/{id}/$meta-add: post: tags: - MedicinalProductInteraction description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductInteraction/$meta: get: tags: - MedicinalProductInteraction 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductInteraction 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductInteraction/{id}/$meta: get: tags: - MedicinalProductInteraction description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductInteraction description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductInteraction/$expunge: post: tags: - MedicinalProductInteraction requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductInteraction/{id}/$expunge: post: tags: - MedicinalProductInteraction parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductManufactured: get: tags: - MedicinalProductManufactured summary: "search-type: Search for MedicinalProductManufactured instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductManufactured/_search: get: tags: - MedicinalProductManufactured summary: "search-type: Search for MedicinalProductManufactured instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductManufactured/$validate: get: tags: - MedicinalProductManufactured parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductManufactured requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductManufactured/{id}/$validate: get: tags: - MedicinalProductManufactured parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductManufactured parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductManufactured/{id}/$meta-delete: post: tags: - MedicinalProductManufactured description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductManufactured/{id}/$meta-add: post: tags: - MedicinalProductManufactured description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductManufactured/$meta: get: tags: - MedicinalProductManufactured 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductManufactured 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductManufactured/{id}/$meta: get: tags: - MedicinalProductManufactured description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductManufactured description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductManufactured/$expunge: post: tags: - MedicinalProductManufactured requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductManufactured/{id}/$expunge: post: tags: - MedicinalProductManufactured parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPackaged: get: tags: - MedicinalProductPackaged summary: "search-type: Search for MedicinalProductPackaged instances" description: This is a search type parameters: - name: identifier in: query description: Unique identifier style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: subject in: query description: The product with this is a pack for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPackaged/_search: get: tags: - MedicinalProductPackaged summary: "search-type: Search for MedicinalProductPackaged instances" description: This is a search type parameters: - name: identifier in: query description: Unique identifier style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: subject in: query description: The product with this is a pack for style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPackaged/$validate: get: tags: - MedicinalProductPackaged parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductPackaged requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPackaged/{id}/$validate: get: tags: - MedicinalProductPackaged parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductPackaged parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPackaged/{id}/$meta-delete: post: tags: - MedicinalProductPackaged description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPackaged/{id}/$meta-add: post: tags: - MedicinalProductPackaged description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPackaged/$meta: get: tags: - MedicinalProductPackaged 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductPackaged 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPackaged/{id}/$meta: get: tags: - MedicinalProductPackaged description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductPackaged description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPackaged/$expunge: post: tags: - MedicinalProductPackaged requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPackaged/{id}/$expunge: post: tags: - MedicinalProductPackaged parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPharmaceutical: get: tags: - MedicinalProductPharmaceutical summary: "search-type: Search for MedicinalProductPharmaceutical instances" description: This is a search type parameters: - name: identifier in: query description: An identifier for the pharmaceutical medicinal product style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: route in: query description: Coded expression for the route style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: target-species in: query description: Coded expression for the species style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPharmaceutical/_search: get: tags: - MedicinalProductPharmaceutical summary: "search-type: Search for MedicinalProductPharmaceutical instances" description: This is a search type parameters: - name: identifier in: query description: An identifier for the pharmaceutical medicinal product style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: route in: query description: Coded expression for the route style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: target-species in: query description: Coded expression for the species style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPharmaceutical/$validate: get: tags: - MedicinalProductPharmaceutical parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductPharmaceutical requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPharmaceutical/{id}/$validate: get: tags: - MedicinalProductPharmaceutical parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductPharmaceutical parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPharmaceutical/{id}/$meta-delete: post: tags: - MedicinalProductPharmaceutical description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPharmaceutical/{id}/$meta-add: post: tags: - MedicinalProductPharmaceutical description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPharmaceutical/$meta: get: tags: - MedicinalProductPharmaceutical 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductPharmaceutical 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPharmaceutical/{id}/$meta: get: tags: - MedicinalProductPharmaceutical description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductPharmaceutical description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPharmaceutical/$expunge: post: tags: - MedicinalProductPharmaceutical requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductPharmaceutical/{id}/$expunge: post: tags: - MedicinalProductPharmaceutical parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductUndesirableEffect: get: tags: - MedicinalProductUndesirableEffect summary: "search-type: Search for MedicinalProductUndesirableEffect instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: subject in: query description: The medication for which this is an undesirable effect style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductUndesirableEffect/_search: get: tags: - MedicinalProductUndesirableEffect summary: "search-type: Search for MedicinalProductUndesirableEffect instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: subject in: query description: The medication for which this is an undesirable effect style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductUndesirableEffect/$validate: get: tags: - MedicinalProductUndesirableEffect parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductUndesirableEffect requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductUndesirableEffect/{id}/$validate: get: tags: - MedicinalProductUndesirableEffect parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductUndesirableEffect parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductUndesirableEffect/{id}/$meta-delete: post: tags: - MedicinalProductUndesirableEffect description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductUndesirableEffect/{id}/$meta-add: post: tags: - MedicinalProductUndesirableEffect description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductUndesirableEffect/$meta: get: tags: - MedicinalProductUndesirableEffect 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductUndesirableEffect 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductUndesirableEffect/{id}/$meta: get: tags: - MedicinalProductUndesirableEffect description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MedicinalProductUndesirableEffect description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductUndesirableEffect/$expunge: post: tags: - MedicinalProductUndesirableEffect requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MedicinalProductUndesirableEffect/{id}/$expunge: post: tags: - MedicinalProductUndesirableEffect parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: parent in: query description: A resource that is the parent of the definition style: simple - name: context-type-value in: query description: "Multiple Resources: \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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - name: focus in: query description: A resource that is a permitted focus of the message style: simple - name: context-type in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: event in: query description: The event that triggers the message or link to the event definition. style: simple - name: context-type-quantity in: query description: "Multiple Resources: \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" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: The behavior associated with the message style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: parent in: query description: A resource that is the parent of the definition style: simple - name: context-type-value in: query description: "Multiple Resources: \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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - name: focus in: query description: A resource that is a permitted focus of the message style: simple - name: context-type in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: event in: query description: The event that triggers the message or link to the event definition. style: simple - name: context-type-quantity in: query description: "Multiple Resources: \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" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: The behavior associated with the message style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageDefinition/$validate: get: tags: - MessageDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MessageDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageDefinition/{id}/$validate: get: tags: - MessageDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MessageDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageDefinition/{id}/$meta-delete: post: tags: - MessageDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageDefinition/{id}/$meta-add: post: tags: - MessageDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageDefinition/$meta: get: tags: - MessageDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MessageDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageDefinition/{id}/$meta: get: tags: - MessageDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MessageDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageDefinition/$expunge: post: tags: - MessageDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageDefinition/{id}/$expunge: post: tags: - MessageDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageHeader: get: tags: - MessageHeader summary: "search-type: Search for MessageHeader instances" description: This is a search type parameters: - name: code in: query description: ok | transient-error | fatal-error style: simple - name: receiver in: query description: Intended "real-world" recipient for the data style: simple - name: author in: query description: The source of the decision style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: destination in: query description: Name of system style: simple - name: focus in: query description: The actual content of the message style: simple - name: source in: query description: Name of system style: simple - name: target in: query description: Particular delivery destination within the destination style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: destination-uri in: query description: Actual destination address or id style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: sender in: query description: Real world sender of the message style: simple - name: source-uri in: query description: Actual message source address or id style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: responsible in: query description: Final responsibility for event style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: enterer in: query description: The source of the data entry style: simple - name: response-id in: query description: Id of original message style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: event in: query description: Code for the event this message represents or link to event definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: receiver in: query description: Intended "real-world" recipient for the data style: simple - name: author in: query description: The source of the decision style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: destination in: query description: Name of system style: simple - name: focus in: query description: The actual content of the message style: simple - name: source in: query description: Name of system style: simple - name: target in: query description: Particular delivery destination within the destination style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: destination-uri in: query description: Actual destination address or id style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: sender in: query description: Real world sender of the message style: simple - name: source-uri in: query description: Actual message source address or id style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: responsible in: query description: Final responsibility for event style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: enterer in: query description: The source of the data entry style: simple - name: response-id in: query description: Id of original message style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: event in: query description: Code for the event this message represents or link to event definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageHeader/$validate: get: tags: - MessageHeader parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MessageHeader requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageHeader/{id}/$validate: get: tags: - MessageHeader parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MessageHeader parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageHeader/{id}/$meta-delete: post: tags: - MessageHeader description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageHeader/{id}/$meta-add: post: tags: - MessageHeader description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageHeader/$meta: get: tags: - MessageHeader 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MessageHeader 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageHeader/{id}/$meta: get: tags: - MessageHeader description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MessageHeader description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageHeader/$expunge: post: tags: - MessageHeader requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MessageHeader/{id}/$expunge: post: tags: - MessageHeader parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MolecularSequence: get: tags: - MolecularSequence summary: "search-type: Search for MolecularSequence instances" description: This is a search type parameters: - name: identifier in: query description: The unique identity for a particular sequence style: simple - name: 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." style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: chromosome in: query description: Chromosome number of the reference sequence style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: Amino Acid Sequence/ DNA Sequence / RNA Sequence style: simple - name: 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." style: simple - 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." style: simple - 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." style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - 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." style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The subject that the observation is about style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: 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." style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - 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." style: simple - name: _id in: query description: Logical id of this artifact style: simple - 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." style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: referenceseqid in: query description: Reference Sequence of the sequence style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - 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." style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: chromosome in: query description: Chromosome number of the reference sequence style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: Amino Acid Sequence/ DNA Sequence / RNA Sequence style: simple - name: 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." style: simple - 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." style: simple - 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." style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - 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." style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The subject that the observation is about style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: 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." style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - 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." style: simple - name: _id in: query description: Logical id of this artifact style: simple - 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." style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: referenceseqid in: query description: Reference Sequence of the sequence style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MolecularSequence/$validate: get: tags: - MolecularSequence parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MolecularSequence requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MolecularSequence/{id}/$validate: get: tags: - MolecularSequence parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MolecularSequence parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MolecularSequence/{id}/$meta-delete: post: tags: - MolecularSequence description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MolecularSequence/{id}/$meta-add: post: tags: - MolecularSequence description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MolecularSequence/$meta: get: tags: - MolecularSequence 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MolecularSequence 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MolecularSequence/{id}/$meta: get: tags: - MolecularSequence description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - MolecularSequence description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MolecularSequence/$expunge: post: tags: - MolecularSequence requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /MolecularSequence/{id}/$expunge: post: tags: - MolecularSequence parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: type in: query description: "e.g. driver, provider, patient, bank etc." style: simple - 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" style: simple - name: contact in: query description: Name of an individual to contact style: simple - name: responsible in: query description: Who maintains system namespace? style: simple - name: context in: query description: "Multiple Resources: \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" style: simple - name: telecom in: query description: Contact details for individual or organization style: simple - name: value in: query description: The unique identifier style: simple - name: context-type-quantity in: query description: "Multiple Resources: \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" style: simple - name: period in: query description: When is identifier valid? style: simple - name: kind in: query description: codesystem | identifier | root style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: id-type in: query description: oid | uuid | uri | other style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: type in: query description: "e.g. driver, provider, patient, bank etc." style: simple - 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" style: simple - name: contact in: query description: Name of an individual to contact style: simple - name: responsible in: query description: Who maintains system namespace? style: simple - name: context in: query description: "Multiple Resources: \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" style: simple - name: telecom in: query description: Contact details for individual or organization style: simple - name: value in: query description: The unique identifier style: simple - name: context-type-quantity in: query description: "Multiple Resources: \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" style: simple - name: period in: query description: When is identifier valid? style: simple - name: kind in: query description: codesystem | identifier | root style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: id-type in: query description: oid | uuid | uri | other style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NamingSystem/$validate: get: tags: - NamingSystem parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - NamingSystem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NamingSystem/{id}/$validate: get: tags: - NamingSystem parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - NamingSystem parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NamingSystem/{id}/$meta-delete: post: tags: - NamingSystem description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NamingSystem/{id}/$meta-add: post: tags: - NamingSystem description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NamingSystem/$meta: get: tags: - NamingSystem 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - NamingSystem 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NamingSystem/{id}/$meta: get: tags: - NamingSystem description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - NamingSystem description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NamingSystem/$expunge: post: tags: - NamingSystem requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NamingSystem/{id}/$expunge: post: tags: - NamingSystem parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - 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" style: simple - name: oraldiet in: query description: "Type of diet that can be consumed orally (i.e., take via the\ \ mouth)." style: simple - name: additive in: query description: Type of module component to add to the feeding style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: datetime in: query description: Return nutrition orders requested on this date style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: provider in: query description: The identity of the provider who placed the nutrition order style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: supplement in: query description: Type of supplement product requested style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: formula in: query description: Type of enteral or infant formula style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Status of the nutrition order. style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - 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" style: simple - name: oraldiet in: query description: "Type of diet that can be consumed orally (i.e., take via the\ \ mouth)." style: simple - name: additive in: query description: Type of module component to add to the feeding style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: datetime in: query description: Return nutrition orders requested on this date style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: provider in: query description: The identity of the provider who placed the nutrition order style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: supplement in: query description: Type of supplement product requested style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: formula in: query description: Type of enteral or infant formula style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Status of the nutrition order. style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NutritionOrder/$validate: get: tags: - NutritionOrder parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - NutritionOrder requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NutritionOrder/{id}/$validate: get: tags: - NutritionOrder parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - NutritionOrder parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NutritionOrder/{id}/$meta-delete: post: tags: - NutritionOrder description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NutritionOrder/{id}/$meta-add: post: tags: - NutritionOrder description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NutritionOrder/$meta: get: tags: - NutritionOrder 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - NutritionOrder 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NutritionOrder/{id}/$meta: get: tags: - NutritionOrder description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - NutritionOrder description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NutritionOrder/$expunge: post: tags: - NutritionOrder requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /NutritionOrder/{id}/$expunge: post: tags: - NutritionOrder parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: combo-data-absent-reason in: query description: "The reason why the expected value in the element Observation.value[x]\ \ or Observation.component.value[x] is missing." style: simple - name: code in: query description: "Multiple Resources: \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" style: simple - name: component-data-absent-reason in: query description: "The reason why the expected value in the element Observation.component.value[x]\ \ is missing." style: simple - name: subject in: query description: The subject that the observation is about style: simple - name: combo-code-value-quantity in: query description: "Code and quantity value parameter pair, including in components" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: value-concept in: query description: "The value of the observation, if the value is a CodeableConcept" style: simple - name: value-date in: query description: "The value of the observation, if the value is a date or period\ \ of time" style: simple - name: derived-from in: query description: Related measurements the observation is made from style: simple - name: focus in: query description: The focus of an observation when the focus is not the patient of record. style: simple - name: part-of in: query description: Part of referenced event style: simple - name: has-member in: query description: Related resource that belongs to the Observation group style: simple - name: code-value-string in: query description: Code and string value parameter pair style: simple - name: component-code-value-quantity in: query description: Component code and component quantity value parameter pair style: simple - name: based-on in: query description: Reference to the service request. style: simple - name: code-value-date in: query description: Code and date/time value parameter pair style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: specimen in: query description: Specimen used for this observation style: simple - name: component-code in: query description: The component code of the observation type style: simple - name: code-value-quantity in: query description: Code and quantity value parameter pair style: simple - name: combo-code-value-concept in: query description: "Code and coded value parameter pair, including in components" style: simple - name: value-string in: query description: "The value of the observation, if the value is a string, and\ \ also searches in CodeableConcept.text" style: simple - name: identifier in: query description: "Multiple Resources: \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" style: simple - name: performer in: query description: Who performed the observation style: simple - name: combo-code in: query description: The code of the observation type or component type style: simple - name: method in: query description: The method used for the observation style: simple - name: value-quantity in: query description: "The value of the observation, if the value is a Quantity, or\ \ a SampledData (just search on the bounds of the values in sampled data)" style: simple - name: component-value-quantity in: query description: "The value of the component observation, if the value is a Quantity,\ \ or a SampledData (just search on the bounds of the values in sampled data)" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: data-absent-reason in: query description: "The reason why the expected value in the element Observation.value[x]\ \ is missing." style: simple - name: combo-value-quantity in: query description: "The value or component value of the observation, if the value\ \ is a Quantity, or a SampledData (just search on the bounds of the values\ \ in sampled data)" style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: code-value-concept in: query description: Code and coded value parameter pair style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: component-code-value-concept in: query description: Component code and component coded value parameter pair style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: component-value-concept in: query description: "The value of the component observation, if the value is a CodeableConcept" style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: The classification of the type of observation style: simple - name: device in: query description: The Device that generated the observation data. style: simple - name: combo-value-concept in: query description: "The value or component value of the observation, if the value\ \ is a CodeableConcept" style: simple - name: status in: query description: The status of the observation style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: combo-data-absent-reason in: query description: "The reason why the expected value in the element Observation.value[x]\ \ or Observation.component.value[x] is missing." style: simple - name: code in: query description: "Multiple Resources: \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" style: simple - name: component-data-absent-reason in: query description: "The reason why the expected value in the element Observation.component.value[x]\ \ is missing." style: simple - name: subject in: query description: The subject that the observation is about style: simple - name: combo-code-value-quantity in: query description: "Code and quantity value parameter pair, including in components" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: value-concept in: query description: "The value of the observation, if the value is a CodeableConcept" style: simple - name: value-date in: query description: "The value of the observation, if the value is a date or period\ \ of time" style: simple - name: derived-from in: query description: Related measurements the observation is made from style: simple - name: focus in: query description: The focus of an observation when the focus is not the patient of record. style: simple - name: part-of in: query description: Part of referenced event style: simple - name: has-member in: query description: Related resource that belongs to the Observation group style: simple - name: code-value-string in: query description: Code and string value parameter pair style: simple - name: component-code-value-quantity in: query description: Component code and component quantity value parameter pair style: simple - name: based-on in: query description: Reference to the service request. style: simple - name: code-value-date in: query description: Code and date/time value parameter pair style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: specimen in: query description: Specimen used for this observation style: simple - name: component-code in: query description: The component code of the observation type style: simple - name: code-value-quantity in: query description: Code and quantity value parameter pair style: simple - name: combo-code-value-concept in: query description: "Code and coded value parameter pair, including in components" style: simple - name: value-string in: query description: "The value of the observation, if the value is a string, and\ \ also searches in CodeableConcept.text" style: simple - name: identifier in: query description: "Multiple Resources: \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" style: simple - name: performer in: query description: Who performed the observation style: simple - name: combo-code in: query description: The code of the observation type or component type style: simple - name: method in: query description: The method used for the observation style: simple - name: value-quantity in: query description: "The value of the observation, if the value is a Quantity, or\ \ a SampledData (just search on the bounds of the values in sampled data)" style: simple - name: component-value-quantity in: query description: "The value of the component observation, if the value is a Quantity,\ \ or a SampledData (just search on the bounds of the values in sampled data)" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: data-absent-reason in: query description: "The reason why the expected value in the element Observation.value[x]\ \ is missing." style: simple - name: combo-value-quantity in: query description: "The value or component value of the observation, if the value\ \ is a Quantity, or a SampledData (just search on the bounds of the values\ \ in sampled data)" style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: code-value-concept in: query description: Code and coded value parameter pair style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: component-code-value-concept in: query description: Component code and component coded value parameter pair style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: component-value-concept in: query description: "The value of the component observation, if the value is a CodeableConcept" style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: The classification of the type of observation style: simple - name: device in: query description: The Device that generated the observation data. style: simple - name: combo-value-concept in: query description: "The value or component value of the observation, if the value\ \ is a CodeableConcept" style: simple - name: status in: query description: The status of the observation style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Observation/$validate: get: tags: - Observation parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Observation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Observation/{id}/$validate: get: tags: - Observation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Observation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Observation/{id}/$meta-delete: post: tags: - Observation description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Observation/{id}/$meta-add: post: tags: - Observation description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Observation/$meta: get: tags: - Observation 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Observation 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Observation/{id}/$meta: get: tags: - Observation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Observation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Observation/$expunge: post: tags: - Observation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Observation/{id}/$expunge: post: tags: - Observation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Observation/$lastn: get: tags: - Observation parameters: - name: _count in: query description: Results from this method are returned across multiple pages. This parameter controls the size of those pages. required: false style: simple - name: category in: query description: The classification of the type of observation required: false style: simple - name: code in: query description: The code of the observation type required: false style: simple - name: date in: query description: The effective date of the observation required: false style: simple - name: patient in: query description: The subject that the observation is about (if patient) required: false style: simple - name: subject in: query description: The subject that the observation is about required: false style: simple - name: max in: query description: The maximum number of observations to return for each observation code required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Observation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ObservationDefinition: get: tags: - ObservationDefinition summary: "search-type: Search for ObservationDefinition instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ObservationDefinition/_search: get: tags: - ObservationDefinition summary: "search-type: Search for ObservationDefinition instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ObservationDefinition/$validate: get: tags: - ObservationDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ObservationDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ObservationDefinition/{id}/$validate: get: tags: - ObservationDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ObservationDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ObservationDefinition/{id}/$meta-delete: post: tags: - ObservationDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ObservationDefinition/{id}/$meta-add: post: tags: - ObservationDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ObservationDefinition/$meta: get: tags: - ObservationDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ObservationDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ObservationDefinition/{id}/$meta: get: tags: - ObservationDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ObservationDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ObservationDefinition/$expunge: post: tags: - ObservationDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ObservationDefinition/{id}/$expunge: post: tags: - ObservationDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: code in: query description: Name used to invoke the operation style: simple - name: instance in: query description: Invoke on an instance? style: simple - name: context-type-value in: query description: "Multiple Resources: \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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: type in: query description: Invoke at the type level? style: simple - 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" style: simple - name: output-profile in: query description: Validation information for out parameters style: simple - 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" style: simple - 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" style: simple - name: kind in: query description: operation | query style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: input-profile in: query description: Validation information for in parameters style: simple - name: system in: query description: Invoke at the system level? style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple - name: base in: query description: Marks this as a profile of the base style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: code in: query description: Name used to invoke the operation style: simple - name: instance in: query description: Invoke on an instance? style: simple - name: context-type-value in: query description: "Multiple Resources: \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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: type in: query description: Invoke at the type level? style: simple - 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" style: simple - name: output-profile in: query description: Validation information for out parameters style: simple - 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" style: simple - 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" style: simple - name: kind in: query description: operation | query style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: input-profile in: query description: Validation information for in parameters style: simple - name: system in: query description: Invoke at the system level? style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple - name: base in: query description: Marks this as a profile of the base style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/$validate: get: tags: - OperationDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OperationDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/{id}/$validate: get: tags: - OperationDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OperationDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/{id}/$meta-delete: post: tags: - OperationDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/{id}/$meta-add: post: tags: - OperationDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/$meta: get: tags: - OperationDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OperationDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/{id}/$meta: get: tags: - OperationDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OperationDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/$expunge: post: tags: - OperationDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationDefinition/{id}/$expunge: post: tags: - OperationDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationOutcome: get: tags: - OperationOutcome summary: "search-type: Search for OperationOutcome instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationOutcome/_search: get: tags: - OperationOutcome summary: "search-type: Search for OperationOutcome instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationOutcome/$validate: get: tags: - OperationOutcome parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OperationOutcome requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationOutcome/{id}/$validate: get: tags: - OperationOutcome parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OperationOutcome parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationOutcome/{id}/$meta-delete: post: tags: - OperationOutcome description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationOutcome/{id}/$meta-add: post: tags: - OperationOutcome description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationOutcome/$meta: get: tags: - OperationOutcome 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OperationOutcome 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationOutcome/{id}/$meta: get: tags: - OperationOutcome description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OperationOutcome description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationOutcome/$expunge: post: tags: - OperationOutcome requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OperationOutcome/{id}/$expunge: post: tags: - OperationOutcome parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization: get: tags: - Organization summary: "search-type: Search for Organization instances" description: This is a search type parameters: - name: identifier in: query description: Any identifier for the organization (not the accreditation issuer's identifier) style: simple - name: partof in: query description: An organization of which this organization forms a part style: simple - name: address in: query description: "A server defined search that may match any of the string fields\ \ in the Address, including line, city, district, state, country, postalCode,\ \ and/or text" style: simple - name: address-state in: query description: A state specified in an address style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Is the Organization record active style: simple - name: type in: query description: A code for the type of organization style: simple - name: address-postalcode in: query description: A postal code specified in an address style: simple - name: address-country in: query description: A country specified in an address style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the organization style: simple - name: phonetic in: query description: A portion of the organization's name using some kind of phonetic matching algorithm style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: A use code specified in an address style: simple - name: name in: query description: A portion of the organization's name or alias style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: address-city in: query description: A city specified in an address style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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) style: simple - name: partof in: query description: An organization of which this organization forms a part style: simple - name: address in: query description: "A server defined search that may match any of the string fields\ \ in the Address, including line, city, district, state, country, postalCode,\ \ and/or text" style: simple - name: address-state in: query description: A state specified in an address style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Is the Organization record active style: simple - name: type in: query description: A code for the type of organization style: simple - name: address-postalcode in: query description: A postal code specified in an address style: simple - name: address-country in: query description: A country specified in an address style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the organization style: simple - name: phonetic in: query description: A portion of the organization's name using some kind of phonetic matching algorithm style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: A use code specified in an address style: simple - name: name in: query description: A portion of the organization's name or alias style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: address-city in: query description: A city specified in an address style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization/$validate: get: tags: - Organization parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Organization requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization/{id}/$validate: get: tags: - Organization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Organization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization/{id}/$meta-delete: post: tags: - Organization description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization/{id}/$meta-add: post: tags: - Organization description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization/$meta: get: tags: - Organization 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Organization 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization/{id}/$meta: get: tags: - Organization description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Organization description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization/$expunge: post: tags: - Organization requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Organization/{id}/$expunge: post: tags: - Organization parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation: get: tags: - OrganizationAffiliation summary: "search-type: Search for OrganizationAffiliation instances" description: This is a search type parameters: - name: date in: query description: The period during which the participatingOrganization is affiliated with the primary organization style: simple - name: identifier in: query description: An organization affiliation's Identifier style: simple - name: specialty in: query description: Specific specialty of the participatingOrganization in the context of the role style: simple - name: role in: query description: Definition of the role the participatingOrganization plays style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether this organization affiliation record is in active use style: simple - name: primary-organization in: query description: The organization that receives the services from the participating organization style: simple - name: network in: query description: Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for this role style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: A value in a phone contact style: simple - name: service in: query description: Healthcare services provided through the role style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: participating-organization in: query description: The organization that provides services to the primary organization style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: The location(s) at which the role occurs style: simple - name: telecom in: query description: The value in any kind of contact style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: email in: query description: A value in an email contact style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: An organization affiliation's Identifier style: simple - name: specialty in: query description: Specific specialty of the participatingOrganization in the context of the role style: simple - name: role in: query description: Definition of the role the participatingOrganization plays style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether this organization affiliation record is in active use style: simple - name: primary-organization in: query description: The organization that receives the services from the participating organization style: simple - name: network in: query description: Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for this role style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: A value in a phone contact style: simple - name: service in: query description: Healthcare services provided through the role style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: participating-organization in: query description: The organization that provides services to the primary organization style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: The location(s) at which the role occurs style: simple - name: telecom in: query description: The value in any kind of contact style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: email in: query description: A value in an email contact style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation/$validate: get: tags: - OrganizationAffiliation parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OrganizationAffiliation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation/{id}/$validate: get: tags: - OrganizationAffiliation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OrganizationAffiliation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation/{id}/$meta-delete: post: tags: - OrganizationAffiliation description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation/{id}/$meta-add: post: tags: - OrganizationAffiliation description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation/$meta: get: tags: - OrganizationAffiliation 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OrganizationAffiliation 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation/{id}/$meta: get: tags: - OrganizationAffiliation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - OrganizationAffiliation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation/$expunge: post: tags: - OrganizationAffiliation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /OrganizationAffiliation/{id}/$expunge: post: tags: - OrganizationAffiliation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Parameters: get: tags: - Parameters summary: "search-type: Search for Parameters instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Parameters/_search: get: tags: - Parameters summary: "search-type: Search for Parameters instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Parameters/$validate: get: tags: - Parameters parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Parameters requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Parameters/{id}/$validate: get: tags: - Parameters parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Parameters parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Parameters/{id}/$meta-delete: post: tags: - Parameters description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Parameters/{id}/$meta-add: post: tags: - Parameters description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Parameters/$meta: get: tags: - Parameters 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Parameters 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Parameters/{id}/$meta: get: tags: - Parameters description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Parameters description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Parameters/$expunge: post: tags: - Parameters requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Parameters/{id}/$expunge: post: tags: - Parameters parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: deceased in: query description: "This patient has been marked as deceased, or as a death date\ \ entered" style: simple - 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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: link in: query description: All patients linked to the given patient style: simple - name: language in: query description: Language code (irrespective of use value) style: simple - name: 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" style: simple - name: death-date in: query description: The date of death has been provided and satisfies this search value style: simple - name: phonetic in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: identifier in: query description: A patient identifier style: simple - 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" style: simple - name: general-practitioner in: query description: "Patient's nominated general practitioner, not the organization\ \ that manages the record" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether the patient record is active style: simple - name: 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The organization that is the custodian of the patient record style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: "Multiple Resources: \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" style: simple - name: name in: query description: "A server defined search that may match any of the string fields\ \ in the HumanName, including family, give, prefix, suffix, suffix, and/or\ \ text" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: family in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: deceased in: query description: "This patient has been marked as deceased, or as a death date\ \ entered" style: simple - 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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: link in: query description: All patients linked to the given patient style: simple - name: language in: query description: Language code (irrespective of use value) style: simple - name: 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" style: simple - name: death-date in: query description: The date of death has been provided and satisfies this search value style: simple - name: phonetic in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: identifier in: query description: A patient identifier style: simple - 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" style: simple - name: general-practitioner in: query description: "Patient's nominated general practitioner, not the organization\ \ that manages the record" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether the patient record is active style: simple - name: 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The organization that is the custodian of the patient record style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: "Multiple Resources: \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" style: simple - name: name in: query description: "A server defined search that may match any of the string fields\ \ in the HumanName, including family, give, prefix, suffix, suffix, and/or\ \ text" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: family in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Patient/$summary: get: tags: - Patient parameters: - name: identifier in: query description: "When the logical id of the patient is not used, servers MAY\ \ choose to support patient selection based on provided identifier" required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Patient requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "identifier", "valueString": "example" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Patient/{id}/$summary: get: tags: - Patient parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: identifier in: query description: "When the logical id of the patient is not used, servers MAY\ \ choose to support patient selection based on provided identifier" required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Patient parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "identifier", "valueString": "example" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Patient/$validate: get: tags: - Patient parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Patient requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Patient/{id}/$validate: get: tags: - Patient parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Patient parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Patient/{id}/$meta-delete: post: tags: - Patient description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Patient/{id}/$meta-add: post: tags: - Patient description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Patient/$meta: get: tags: - Patient 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Patient 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Patient/{id}/$meta: get: tags: - Patient description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Patient description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Patient/$expunge: post: tags: - Patient requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Patient/{id}/$expunge: post: tags: - Patient parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Patient/$everything: get: tags: - Patient parameters: - name: _count in: query description: Results from this method are returned across multiple pages. This parameter controls the size of those pages. required: false style: simple - name: _offset in: query description: Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page. required: false style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range required: false style: simple - name: _content in: query description: "Filter the resources to return only resources matching the given\ \ _content filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _text in: query description: "Filter the resources to return only resources matching the given\ \ _text filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _filter in: query description: "Filter the resources to return only resources matching the given\ \ _filter filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _type in: query description: "Filter the resources to return only resources matching the given\ \ _type filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _id in: query description: Filter the resources to return based on the patient ids provided. required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Patient requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Patient/{id}/$everything: get: tags: - Patient parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: _count in: query description: Results from this method are returned across multiple pages. This parameter controls the size of those pages. required: false style: simple - name: _offset in: query description: Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page. required: false style: simple - name: _lastUpdated in: query description: Only return resources which were last updated as specified by the given range required: false style: simple - name: _content in: query description: "Filter the resources to return only resources matching the given\ \ _content filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _text in: query description: "Filter the resources to return only resources matching the given\ \ _text filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _filter in: query description: "Filter the resources to return only resources matching the given\ \ _filter filter (note that this filter is applied only to results which\ \ link to the given patient, not to the patient itself or to supporting\ \ resources linked to by the matched resources)" required: false style: simple - name: _type in: query description: "Filter the resources to return only resources matching the given\ \ _type filter (note that this filter is applied only to results which link\ \ to the given patient, not to the patient itself or to supporting resources\ \ linked to by the matched resources)" required: false style: simple - name: _id in: query description: Filter the resources to return based on the patient ids provided. required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Patient parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentNotice: get: tags: - PaymentNotice summary: "search-type: Search for PaymentNotice instances" description: This is a search type parameters: - name: identifier in: query description: The business identifier of the notice style: simple - name: request in: query description: The Claim style: simple - name: created in: query description: Creation date fro the notice style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: payment-status in: query description: The type of payment notice style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: provider in: query description: The reference to the provider style: simple - name: response in: query description: The ClaimResponse style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the payment notice style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: request in: query description: The Claim style: simple - name: created in: query description: Creation date fro the notice style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: payment-status in: query description: The type of payment notice style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: provider in: query description: The reference to the provider style: simple - name: response in: query description: The ClaimResponse style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the payment notice style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentNotice/$validate: get: tags: - PaymentNotice parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PaymentNotice requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentNotice/{id}/$validate: get: tags: - PaymentNotice parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PaymentNotice parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentNotice/{id}/$meta-delete: post: tags: - PaymentNotice description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentNotice/{id}/$meta-add: post: tags: - PaymentNotice description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentNotice/$meta: get: tags: - PaymentNotice 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PaymentNotice 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentNotice/{id}/$meta: get: tags: - PaymentNotice description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PaymentNotice description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentNotice/$expunge: post: tags: - PaymentNotice requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentNotice/{id}/$expunge: post: tags: - PaymentNotice parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentReconciliation: get: tags: - PaymentReconciliation summary: "search-type: Search for PaymentReconciliation instances" description: This is a search type parameters: - name: identifier in: query description: The business identifier of the ExplanationOfBenefit style: simple - name: request in: query description: The reference to the claim style: simple - name: created in: query description: The creation date style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: requestor in: query description: The reference to the provider who submitted the claim style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: disposition in: query description: The contents of the disposition message style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: outcome in: query description: The processing outcome style: simple - name: payment-issuer in: query description: The organization which generated this resource style: simple - name: status in: query description: The status of the payment reconciliation style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: request in: query description: The reference to the claim style: simple - name: created in: query description: The creation date style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: requestor in: query description: The reference to the provider who submitted the claim style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: disposition in: query description: The contents of the disposition message style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: outcome in: query description: The processing outcome style: simple - name: payment-issuer in: query description: The organization which generated this resource style: simple - name: status in: query description: The status of the payment reconciliation style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentReconciliation/$validate: get: tags: - PaymentReconciliation parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PaymentReconciliation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentReconciliation/{id}/$validate: get: tags: - PaymentReconciliation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PaymentReconciliation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentReconciliation/{id}/$meta-delete: post: tags: - PaymentReconciliation description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentReconciliation/{id}/$meta-add: post: tags: - PaymentReconciliation description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentReconciliation/$meta: get: tags: - PaymentReconciliation 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PaymentReconciliation 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentReconciliation/{id}/$meta: get: tags: - PaymentReconciliation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PaymentReconciliation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentReconciliation/$expunge: post: tags: - PaymentReconciliation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PaymentReconciliation/{id}/$expunge: post: tags: - PaymentReconciliation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: link in: query description: "Any link has this Patient, Person, RelatedPerson or Practitioner\ \ reference" style: simple - name: address-country in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: patient in: query description: The Person links to this Patient style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: identifier in: query description: A person Identifier style: simple - 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" style: simple - name: practitioner in: query description: The Person links to this Practitioner style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: relatedperson in: query description: The Person links to this RelatedPerson style: simple - name: address-postalcode in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The organization at which this person record is being managed style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: "Multiple Resources: \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" style: simple - name: name in: query description: "A server defined search that may match any of the string fields\ \ in the HumanName, including family, give, prefix, suffix, suffix, and/or\ \ text" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: link in: query description: "Any link has this Patient, Person, RelatedPerson or Practitioner\ \ reference" style: simple - name: address-country in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: patient in: query description: The Person links to this Patient style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: identifier in: query description: A person Identifier style: simple - 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" style: simple - name: practitioner in: query description: The Person links to this Practitioner style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: relatedperson in: query description: The Person links to this RelatedPerson style: simple - name: address-postalcode in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The organization at which this person record is being managed style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: "Multiple Resources: \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" style: simple - name: name in: query description: "A server defined search that may match any of the string fields\ \ in the HumanName, including family, give, prefix, suffix, suffix, and/or\ \ text" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Person/$validate: get: tags: - Person parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Person requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Person/{id}/$validate: get: tags: - Person parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Person parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Person/{id}/$meta-delete: post: tags: - Person description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Person/{id}/$meta-add: post: tags: - Person description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Person/$meta: get: tags: - Person 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Person 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Person/{id}/$meta: get: tags: - Person description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Person description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Person/$expunge: post: tags: - Person requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Person/{id}/$expunge: post: tags: - Person parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PlanDefinition: get: tags: - PlanDefinition summary: "search-type: Search for PlanDefinition instances" description: This is a search type parameters: - name: date in: query description: The plan definition publication date style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the plan definition style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the plan definition style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the plan definition style: simple - name: context-type in: query description: A type of use context assigned to the plan definition style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the plan definition style: simple - name: type in: query description: "The type of artifact the plan (e.g. order-set, eca-rule, protocol)" style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the plan definition style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the plan definition is intended to be in use style: simple - name: context in: query description: A use context assigned to the plan definition style: simple - name: definition in: query description: Activity or plan definitions used by plan definition style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the plan definition style: simple - name: identifier in: query description: External identifier for the plan definition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the plan definition style: simple - name: url in: query description: The uri that identifies the plan definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the plan definition style: simple - name: publisher in: query description: Name of the publisher of the plan definition style: simple - name: topic in: query description: Topics associated with the module style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the plan definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the plan definition style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the plan definition style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the plan definition style: simple - name: context-type in: query description: A type of use context assigned to the plan definition style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the plan definition style: simple - name: type in: query description: "The type of artifact the plan (e.g. order-set, eca-rule, protocol)" style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the plan definition style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the plan definition is intended to be in use style: simple - name: context in: query description: A use context assigned to the plan definition style: simple - name: definition in: query description: Activity or plan definitions used by plan definition style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the plan definition style: simple - name: identifier in: query description: External identifier for the plan definition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the plan definition style: simple - name: url in: query description: The uri that identifies the plan definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the plan definition style: simple - name: publisher in: query description: Name of the publisher of the plan definition style: simple - name: topic in: query description: Topics associated with the module style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the plan definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PlanDefinition/$validate: get: tags: - PlanDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PlanDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PlanDefinition/{id}/$validate: get: tags: - PlanDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PlanDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PlanDefinition/{id}/$meta-delete: post: tags: - PlanDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PlanDefinition/{id}/$meta-add: post: tags: - PlanDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PlanDefinition/$meta: get: tags: - PlanDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PlanDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PlanDefinition/{id}/$meta: get: tags: - PlanDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PlanDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PlanDefinition/$expunge: post: tags: - PlanDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PlanDefinition/{id}/$expunge: post: tags: - PlanDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: communication in: query description: One of the languages that the practitioner can communicate with style: simple - name: email in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: identifier in: query description: A practitioner's Identifier style: simple - 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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether the practitioner record is active style: simple - name: address-postalcode in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: "Multiple Resources: \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" style: simple - name: name in: query description: "A server defined search that may match any of the string fields\ \ in the HumanName, including family, give, prefix, suffix, suffix, and/or\ \ text" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: family in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: communication in: query description: One of the languages that the practitioner can communicate with style: simple - name: email in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: identifier in: query description: A practitioner's Identifier style: simple - 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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether the practitioner record is active style: simple - name: address-postalcode in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: "Multiple Resources: \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" style: simple - name: name in: query description: "A server defined search that may match any of the string fields\ \ in the HumanName, including family, give, prefix, suffix, suffix, and/or\ \ text" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: family in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Practitioner/$validate: get: tags: - Practitioner parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Practitioner requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Practitioner/{id}/$validate: get: tags: - Practitioner parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Practitioner parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Practitioner/{id}/$meta-delete: post: tags: - Practitioner description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Practitioner/{id}/$meta-add: post: tags: - Practitioner description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Practitioner/$meta: get: tags: - Practitioner 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Practitioner 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Practitioner/{id}/$meta: get: tags: - Practitioner description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Practitioner description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Practitioner/$expunge: post: tags: - Practitioner requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Practitioner/{id}/$expunge: post: tags: - Practitioner parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole: get: tags: - PractitionerRole summary: "search-type: Search for PractitionerRole instances" description: This is a search type parameters: - name: date in: query description: The period during which the practitioner is authorized to perform in these role(s) style: simple - name: identifier in: query description: A practitioner's Identifier style: simple - name: specialty in: query description: The practitioner has this specialty at an organization style: simple - name: role in: query description: The practitioner can perform this role at for the organization style: simple - name: practitioner in: query description: Practitioner that is able to provide the defined services for the organization style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether this practitioner role record is in active use style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the practitioner with this role style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \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" style: simple - name: service in: query description: The list of healthcare services that this worker provides for this role's Organization/Location(s) style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The identity of the organization the practitioner represents / acts on behalf of style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: telecom in: query description: "Multiple Resources: \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" style: simple - name: location in: query description: One of the locations at which this practitioner provides care style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: email in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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) style: simple - name: identifier in: query description: A practitioner's Identifier style: simple - name: specialty in: query description: The practitioner has this specialty at an organization style: simple - name: role in: query description: The practitioner can perform this role at for the organization style: simple - name: practitioner in: query description: Practitioner that is able to provide the defined services for the organization style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether this practitioner role record is in active use style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the practitioner with this role style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \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" style: simple - name: service in: query description: The list of healthcare services that this worker provides for this role's Organization/Location(s) style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The identity of the organization the practitioner represents / acts on behalf of style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: telecom in: query description: "Multiple Resources: \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" style: simple - name: location in: query description: One of the locations at which this practitioner provides care style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: email in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/$validate: get: tags: - PractitionerRole parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PractitionerRole requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/{id}/$validate: get: tags: - PractitionerRole parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PractitionerRole parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/{id}/$meta-delete: post: tags: - PractitionerRole description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/{id}/$meta-add: post: tags: - PractitionerRole description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/$meta: get: tags: - PractitionerRole 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PractitionerRole 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/{id}/$meta: get: tags: - PractitionerRole description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PractitionerRole description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/$expunge: post: tags: - PractitionerRole requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/{id}/$expunge: post: tags: - PractitionerRole parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: subject in: query description: Search by subject style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: part-of in: query description: Part of referenced event style: simple - name: reason-code in: query description: Coded reason procedure performed style: simple - name: based-on in: query description: A request for this procedure style: simple - 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" style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - 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" style: simple - name: performer in: query description: The reference to the practitioner style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: reason-reference in: query description: The justification that the procedure was performed style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: Where the procedure happened style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Classification of the procedure style: simple - name: status in: query description: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: subject in: query description: Search by subject style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: part-of in: query description: Part of referenced event style: simple - name: reason-code in: query description: Coded reason procedure performed style: simple - name: based-on in: query description: A request for this procedure style: simple - 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" style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - 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" style: simple - name: performer in: query description: The reference to the practitioner style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: reason-reference in: query description: The justification that the procedure was performed style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: Where the procedure happened style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Classification of the procedure style: simple - name: status in: query description: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Procedure/$validate: get: tags: - Procedure parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Procedure requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Procedure/{id}/$validate: get: tags: - Procedure parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Procedure parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Procedure/{id}/$meta-delete: post: tags: - Procedure description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Procedure/{id}/$meta-add: post: tags: - Procedure description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Procedure/$meta: get: tags: - Procedure 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Procedure 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Procedure/{id}/$meta: get: tags: - Procedure description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Procedure description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Procedure/$expunge: post: tags: - Procedure requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Procedure/{id}/$expunge: post: tags: - Procedure parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Provenance: get: tags: - Provenance summary: "search-type: Search for Provenance instances" description: This is a search type parameters: - name: agent-type in: query description: How the agent participated style: simple - name: agent in: query description: Who participated style: simple - name: signature-type in: query description: Indication of the reason the entity signed the object(s) style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: recorded in: query description: When the activity was recorded / updated style: simple - name: when in: query description: When the activity occurred style: simple - name: target in: query description: Target Reference(s) (usually version specific) style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: Target Reference(s) (usually version specific) style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: "Where the activity occurred, if relevant" style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: agent-role in: query description: What the agents role was style: simple - name: entity in: query description: Identity of entity style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: agent in: query description: Who participated style: simple - name: signature-type in: query description: Indication of the reason the entity signed the object(s) style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: recorded in: query description: When the activity was recorded / updated style: simple - name: when in: query description: When the activity occurred style: simple - name: target in: query description: Target Reference(s) (usually version specific) style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: Target Reference(s) (usually version specific) style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: "Where the activity occurred, if relevant" style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: agent-role in: query description: What the agents role was style: simple - name: entity in: query description: Identity of entity style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Provenance/$validate: get: tags: - Provenance parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Provenance requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Provenance/{id}/$validate: get: tags: - Provenance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Provenance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Provenance/{id}/$meta-delete: post: tags: - Provenance description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Provenance/{id}/$meta-add: post: tags: - Provenance description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Provenance/$meta: get: tags: - Provenance 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Provenance 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Provenance/{id}/$meta: get: tags: - Provenance description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Provenance description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Provenance/$expunge: post: tags: - Provenance requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Provenance/{id}/$expunge: post: tags: - Provenance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Questionnaire: get: tags: - Questionnaire summary: "search-type: Search for Questionnaire instances" description: This is a search type parameters: - name: date in: query description: The questionnaire publication date style: simple - name: code in: query description: A code that corresponds to one of its items in the questionnaire style: simple - name: context-type-value in: query description: A use context type and value assigned to the questionnaire style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the questionnaire style: simple - name: description in: query description: The description of the questionnaire style: simple - name: context-type in: query description: A type of use context assigned to the questionnaire style: simple - name: title in: query description: The human-friendly name of the questionnaire style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the questionnaire style: simple - name: effective in: query description: The time during which the questionnaire is intended to be in use style: simple - name: context in: query description: A use context assigned to the questionnaire style: simple - name: definition in: query description: ElementDefinition - details for the item style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the questionnaire style: simple - name: identifier in: query description: External identifier for the questionnaire style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the questionnaire style: simple - name: url in: query description: The uri that identifies the questionnaire style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: subject-type in: query description: Resource that can be subject of QuestionnaireResponse style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the questionnaire style: simple - name: publisher in: query description: Name of the publisher of the questionnaire style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the questionnaire style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: code in: query description: A code that corresponds to one of its items in the questionnaire style: simple - name: context-type-value in: query description: A use context type and value assigned to the questionnaire style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the questionnaire style: simple - name: description in: query description: The description of the questionnaire style: simple - name: context-type in: query description: A type of use context assigned to the questionnaire style: simple - name: title in: query description: The human-friendly name of the questionnaire style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the questionnaire style: simple - name: effective in: query description: The time during which the questionnaire is intended to be in use style: simple - name: context in: query description: A use context assigned to the questionnaire style: simple - name: definition in: query description: ElementDefinition - details for the item style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the questionnaire style: simple - name: identifier in: query description: External identifier for the questionnaire style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the questionnaire style: simple - name: url in: query description: The uri that identifies the questionnaire style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: subject-type in: query description: Resource that can be subject of QuestionnaireResponse style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the questionnaire style: simple - name: publisher in: query description: Name of the publisher of the questionnaire style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the questionnaire style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Questionnaire/$validate: get: tags: - Questionnaire parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Questionnaire requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Questionnaire/{id}/$validate: get: tags: - Questionnaire parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Questionnaire parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Questionnaire/{id}/$meta-delete: post: tags: - Questionnaire description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Questionnaire/{id}/$meta-add: post: tags: - Questionnaire description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Questionnaire/$meta: get: tags: - Questionnaire 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Questionnaire 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Questionnaire/{id}/$meta: get: tags: - Questionnaire description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Questionnaire description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Questionnaire/$expunge: post: tags: - Questionnaire requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Questionnaire/{id}/$expunge: post: tags: - Questionnaire parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /QuestionnaireResponse: get: tags: - QuestionnaireResponse summary: "search-type: Search for QuestionnaireResponse instances" description: This is a search type parameters: - name: authored in: query description: When the questionnaire response was last changed style: simple - name: identifier in: query description: The unique identifier for the questionnaire response style: simple - name: questionnaire in: query description: The questionnaire the answers are provided for style: simple - name: author in: query description: The author of the questionnaire response style: simple - name: subject in: query description: The subject of the questionnaire response style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: part-of in: query description: Procedure or observation this questionnaire response was performed as a part of style: simple - name: encounter in: query description: Encounter associated with the questionnaire response style: simple - name: source in: query description: The individual providing the information reflected in the questionnaire respose style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: based-on in: query description: Plan/proposal/order fulfilled by this questionnaire response style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The patient that is the subject of the questionnaire response style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the questionnaire response style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: The unique identifier for the questionnaire response style: simple - name: questionnaire in: query description: The questionnaire the answers are provided for style: simple - name: author in: query description: The author of the questionnaire response style: simple - name: subject in: query description: The subject of the questionnaire response style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: part-of in: query description: Procedure or observation this questionnaire response was performed as a part of style: simple - name: encounter in: query description: Encounter associated with the questionnaire response style: simple - name: source in: query description: The individual providing the information reflected in the questionnaire respose style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: based-on in: query description: Plan/proposal/order fulfilled by this questionnaire response style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The patient that is the subject of the questionnaire response style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the questionnaire response style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /QuestionnaireResponse/$validate: get: tags: - QuestionnaireResponse parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - QuestionnaireResponse requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /QuestionnaireResponse/{id}/$validate: get: tags: - QuestionnaireResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - QuestionnaireResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /QuestionnaireResponse/{id}/$meta-delete: post: tags: - QuestionnaireResponse description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /QuestionnaireResponse/{id}/$meta-add: post: tags: - QuestionnaireResponse description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /QuestionnaireResponse/$meta: get: tags: - QuestionnaireResponse 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - QuestionnaireResponse 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /QuestionnaireResponse/{id}/$meta: get: tags: - QuestionnaireResponse description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - QuestionnaireResponse description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /QuestionnaireResponse/$expunge: post: tags: - QuestionnaireResponse requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /QuestionnaireResponse/{id}/$expunge: post: tags: - QuestionnaireResponse parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - name: patient in: query description: The patient this related person is related to style: simple - 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" style: simple - 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" style: simple - name: relationship in: query description: The relationship between the patient and the relatedperson style: simple - 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" style: simple - name: identifier in: query description: An Identifier of the RelatedPerson style: simple - 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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Indicates if the related person record is active style: simple - name: address-postalcode in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: "Multiple Resources: \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" style: simple - name: name in: query description: "A server defined search that may match any of the string fields\ \ in the HumanName, including family, give, prefix, suffix, suffix, and/or\ \ text" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - name: patient in: query description: The patient this related person is related to style: simple - 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" style: simple - 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" style: simple - name: relationship in: query description: The relationship between the patient and the relatedperson style: simple - 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" style: simple - name: identifier in: query description: An Identifier of the RelatedPerson style: simple - 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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Indicates if the related person record is active style: simple - name: address-postalcode in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: "Multiple Resources: \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" style: simple - name: name in: query description: "A server defined search that may match any of the string fields\ \ in the HumanName, including family, give, prefix, suffix, suffix, and/or\ \ text" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RelatedPerson/$validate: get: tags: - RelatedPerson parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RelatedPerson requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RelatedPerson/{id}/$validate: get: tags: - RelatedPerson parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RelatedPerson parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RelatedPerson/{id}/$meta-delete: post: tags: - RelatedPerson description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RelatedPerson/{id}/$meta-add: post: tags: - RelatedPerson description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RelatedPerson/$meta: get: tags: - RelatedPerson 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RelatedPerson 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RelatedPerson/{id}/$meta: get: tags: - RelatedPerson description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RelatedPerson description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RelatedPerson/$expunge: post: tags: - RelatedPerson requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RelatedPerson/{id}/$expunge: post: tags: - RelatedPerson parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RequestGroup: get: tags: - RequestGroup summary: "search-type: Search for RequestGroup instances" description: This is a search type parameters: - name: authored in: query description: The date the request group was authored style: simple - name: identifier in: query description: External identifiers for the request group style: simple - name: code in: query description: The code of the request group style: simple - name: author in: query description: The author of the request group style: simple - name: subject in: query description: The subject that the request group is about style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: The FHIR-based definition from which the request group is realized style: simple - name: encounter in: query description: The encounter the request group applies to style: simple - name: priority in: query description: The priority of the request group style: simple - name: intent in: query description: The intent of the request group style: simple - name: participant in: query description: The participant in the requests in the group style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: group-identifier in: query description: The group identifier for the request group style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The identity of a patient to search for request groups style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: instantiates-uri in: query description: The external definition from which the request group is realized style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the request group style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: External identifiers for the request group style: simple - name: code in: query description: The code of the request group style: simple - name: author in: query description: The author of the request group style: simple - name: subject in: query description: The subject that the request group is about style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: The FHIR-based definition from which the request group is realized style: simple - name: encounter in: query description: The encounter the request group applies to style: simple - name: priority in: query description: The priority of the request group style: simple - name: intent in: query description: The intent of the request group style: simple - name: participant in: query description: The participant in the requests in the group style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: group-identifier in: query description: The group identifier for the request group style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The identity of a patient to search for request groups style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: instantiates-uri in: query description: The external definition from which the request group is realized style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the request group style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RequestGroup/$validate: get: tags: - RequestGroup parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RequestGroup requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RequestGroup/{id}/$validate: get: tags: - RequestGroup parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RequestGroup parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RequestGroup/{id}/$meta-delete: post: tags: - RequestGroup description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RequestGroup/{id}/$meta-add: post: tags: - RequestGroup description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RequestGroup/$meta: get: tags: - RequestGroup 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RequestGroup 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RequestGroup/{id}/$meta: get: tags: - RequestGroup description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RequestGroup description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RequestGroup/$expunge: post: tags: - RequestGroup requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RequestGroup/{id}/$expunge: post: tags: - RequestGroup parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the research definition style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the research definition style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the research definition style: simple - name: context-type in: query description: A type of use context assigned to the research definition style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the research definition style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the research definition style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the research definition is intended to be in use style: simple - name: context in: query description: A use context assigned to the research definition style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the research definition style: simple - name: identifier in: query description: External identifier for the research definition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the research definition style: simple - name: url in: query description: The uri that identifies the research definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the research definition style: simple - name: publisher in: query description: Name of the publisher of the research definition style: simple - name: topic in: query description: Topics associated with the ResearchDefinition style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the research definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the research definition style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the research definition style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the research definition style: simple - name: context-type in: query description: A type of use context assigned to the research definition style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the research definition style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the research definition style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the research definition is intended to be in use style: simple - name: context in: query description: A use context assigned to the research definition style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the research definition style: simple - name: identifier in: query description: External identifier for the research definition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the research definition style: simple - name: url in: query description: The uri that identifies the research definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the research definition style: simple - name: publisher in: query description: Name of the publisher of the research definition style: simple - name: topic in: query description: Topics associated with the ResearchDefinition style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the research definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchDefinition/$validate: get: tags: - ResearchDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchDefinition/{id}/$validate: get: tags: - ResearchDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchDefinition/{id}/$meta-delete: post: tags: - ResearchDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchDefinition/{id}/$meta-add: post: tags: - ResearchDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchDefinition/$meta: get: tags: - ResearchDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchDefinition/{id}/$meta: get: tags: - ResearchDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchDefinition/$expunge: post: tags: - ResearchDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchDefinition/{id}/$expunge: post: tags: - ResearchDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the research element definition style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the research element definition style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the research element definition style: simple - name: context-type in: query description: A type of use context assigned to the research element definition style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the research element definition style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the research element definition style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the research element definition is intended to be in use style: simple - name: context in: query description: A use context assigned to the research element definition style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the research element definition style: simple - name: identifier in: query description: External identifier for the research element definition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the research element definition style: simple - name: url in: query description: The uri that identifies the research element definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the research element definition style: simple - name: publisher in: query description: Name of the publisher of the research element definition style: simple - name: topic in: query description: Topics associated with the ResearchElementDefinition style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the research element definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: successor in: query description: What resource is being referenced style: simple - name: context-type-value in: query description: A use context type and value assigned to the research element definition style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the research element definition style: simple - name: derived-from in: query description: What resource is being referenced style: simple - name: description in: query description: The description of the research element definition style: simple - name: context-type in: query description: A type of use context assigned to the research element definition style: simple - name: predecessor in: query description: What resource is being referenced style: simple - name: composed-of in: query description: What resource is being referenced style: simple - name: title in: query description: The human-friendly name of the research element definition style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the research element definition style: simple - name: depends-on in: query description: What resource is being referenced style: simple - name: effective in: query description: The time during which the research element definition is intended to be in use style: simple - name: context in: query description: A use context assigned to the research element definition style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the research element definition style: simple - name: identifier in: query description: External identifier for the research element definition style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the research element definition style: simple - name: url in: query description: The uri that identifies the research element definition style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the research element definition style: simple - name: publisher in: query description: Name of the publisher of the research element definition style: simple - name: topic in: query description: Topics associated with the ResearchElementDefinition style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the research element definition style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchElementDefinition/$validate: get: tags: - ResearchElementDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchElementDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchElementDefinition/{id}/$validate: get: tags: - ResearchElementDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchElementDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchElementDefinition/{id}/$meta-delete: post: tags: - ResearchElementDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchElementDefinition/{id}/$meta-add: post: tags: - ResearchElementDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchElementDefinition/$meta: get: tags: - ResearchElementDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchElementDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchElementDefinition/{id}/$meta: get: tags: - ResearchElementDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchElementDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchElementDefinition/$expunge: post: tags: - ResearchElementDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchElementDefinition/{id}/$expunge: post: tags: - ResearchElementDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchStudy: get: tags: - ResearchStudy summary: "search-type: Search for ResearchStudy instances" description: This is a search type parameters: - name: date in: query description: When the study began and ended style: simple - name: identifier in: query description: Business Identifier for study style: simple - name: partof in: query description: Part of larger study style: simple - name: sponsor in: query description: Organization that initiates and is legally responsible for the study style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: focus in: query description: "Drugs, devices, etc. under study" style: simple - name: principalinvestigator in: query description: Researcher who oversees multiple aspects of the study style: simple - name: title in: query description: Name for this study style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: protocol in: query description: Steps followed in executing study style: simple - name: site in: query description: Facility where study activities are conducted style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: Geographic region(s) for study style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Classifications for the study style: simple - name: keyword in: query description: Used to search for the study style: simple - 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 style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: Business Identifier for study style: simple - name: partof in: query description: Part of larger study style: simple - name: sponsor in: query description: Organization that initiates and is legally responsible for the study style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: focus in: query description: "Drugs, devices, etc. under study" style: simple - name: principalinvestigator in: query description: Researcher who oversees multiple aspects of the study style: simple - name: title in: query description: Name for this study style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: protocol in: query description: Steps followed in executing study style: simple - name: site in: query description: Facility where study activities are conducted style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: location in: query description: Geographic region(s) for study style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: Classifications for the study style: simple - name: keyword in: query description: Used to search for the study style: simple - 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 style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchStudy/$validate: get: tags: - ResearchStudy parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchStudy requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchStudy/{id}/$validate: get: tags: - ResearchStudy parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchStudy parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchStudy/{id}/$meta-delete: post: tags: - ResearchStudy description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchStudy/{id}/$meta-add: post: tags: - ResearchStudy description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchStudy/$meta: get: tags: - ResearchStudy 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchStudy 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchStudy/{id}/$meta: get: tags: - ResearchStudy description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchStudy description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchStudy/$expunge: post: tags: - ResearchStudy requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchStudy/{id}/$expunge: post: tags: - ResearchStudy parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchSubject: get: tags: - ResearchSubject summary: "search-type: Search for ResearchSubject instances" description: This is a search type parameters: - name: date in: query description: Start and end of participation style: simple - name: identifier in: query description: Business Identifier for research subject in a study style: simple - name: study in: query description: Study subject is part of style: simple - name: individual in: query description: Who is part of study style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: Who is part of study style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: Business Identifier for research subject in a study style: simple - name: study in: query description: Study subject is part of style: simple - name: individual in: query description: Who is part of study style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: Who is part of study style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchSubject/$validate: get: tags: - ResearchSubject parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchSubject requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchSubject/{id}/$validate: get: tags: - ResearchSubject parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchSubject parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchSubject/{id}/$meta-delete: post: tags: - ResearchSubject description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchSubject/{id}/$meta-add: post: tags: - ResearchSubject description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchSubject/$meta: get: tags: - ResearchSubject 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchSubject 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchSubject/{id}/$meta: get: tags: - ResearchSubject description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ResearchSubject description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchSubject/$expunge: post: tags: - ResearchSubject requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ResearchSubject/{id}/$expunge: post: tags: - ResearchSubject parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: performer in: query description: Who did assessment? style: simple - name: method in: query description: Evaluation mechanism style: simple - name: probability in: query description: Likelihood of specified outcome style: simple - name: subject in: query description: Who/what does assessment apply to? style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: condition in: query description: Condition assessed style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: risk in: query description: Likelihood of specified outcome as a qualitative value style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: performer in: query description: Who did assessment? style: simple - name: method in: query description: Evaluation mechanism style: simple - name: probability in: query description: Likelihood of specified outcome style: simple - name: subject in: query description: Who/what does assessment apply to? style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: condition in: query description: Condition assessed style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: risk in: query description: Likelihood of specified outcome as a qualitative value style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskAssessment/$validate: get: tags: - RiskAssessment parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RiskAssessment requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskAssessment/{id}/$validate: get: tags: - RiskAssessment parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RiskAssessment parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskAssessment/{id}/$meta-delete: post: tags: - RiskAssessment description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskAssessment/{id}/$meta-add: post: tags: - RiskAssessment description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskAssessment/$meta: get: tags: - RiskAssessment 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RiskAssessment 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskAssessment/{id}/$meta: get: tags: - RiskAssessment description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RiskAssessment description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskAssessment/$expunge: post: tags: - RiskAssessment requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskAssessment/{id}/$expunge: post: tags: - RiskAssessment parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: context-type-value in: query description: A use context type and value assigned to the risk evidence synthesis style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the risk evidence synthesis style: simple - name: description in: query description: The description of the risk evidence synthesis style: simple - name: context-type in: query description: A type of use context assigned to the risk evidence synthesis style: simple - name: title in: query description: The human-friendly name of the risk evidence synthesis style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the risk evidence synthesis style: simple - name: effective in: query description: The time during which the risk evidence synthesis is intended to be in use style: simple - name: context in: query description: A use context assigned to the risk evidence synthesis style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the risk evidence synthesis style: simple - name: identifier in: query description: External identifier for the risk evidence synthesis style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the risk evidence synthesis style: simple - name: url in: query description: The uri that identifies the risk evidence synthesis style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the risk evidence synthesis style: simple - name: publisher in: query description: Name of the publisher of the risk evidence synthesis style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the risk evidence synthesis style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: context-type-value in: query description: A use context type and value assigned to the risk evidence synthesis style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the risk evidence synthesis style: simple - name: description in: query description: The description of the risk evidence synthesis style: simple - name: context-type in: query description: A type of use context assigned to the risk evidence synthesis style: simple - name: title in: query description: The human-friendly name of the risk evidence synthesis style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the risk evidence synthesis style: simple - name: effective in: query description: The time during which the risk evidence synthesis is intended to be in use style: simple - name: context in: query description: A use context assigned to the risk evidence synthesis style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the risk evidence synthesis style: simple - name: identifier in: query description: External identifier for the risk evidence synthesis style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the risk evidence synthesis style: simple - name: url in: query description: The uri that identifies the risk evidence synthesis style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the risk evidence synthesis style: simple - name: publisher in: query description: Name of the publisher of the risk evidence synthesis style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the risk evidence synthesis style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskEvidenceSynthesis/$validate: get: tags: - RiskEvidenceSynthesis parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RiskEvidenceSynthesis requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskEvidenceSynthesis/{id}/$validate: get: tags: - RiskEvidenceSynthesis parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RiskEvidenceSynthesis parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskEvidenceSynthesis/{id}/$meta-delete: post: tags: - RiskEvidenceSynthesis description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskEvidenceSynthesis/{id}/$meta-add: post: tags: - RiskEvidenceSynthesis description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskEvidenceSynthesis/$meta: get: tags: - RiskEvidenceSynthesis 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RiskEvidenceSynthesis 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskEvidenceSynthesis/{id}/$meta: get: tags: - RiskEvidenceSynthesis description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - RiskEvidenceSynthesis description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskEvidenceSynthesis/$expunge: post: tags: - RiskEvidenceSynthesis requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /RiskEvidenceSynthesis/{id}/$expunge: post: tags: - RiskEvidenceSynthesis parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Schedule: get: tags: - Schedule summary: "search-type: Search for Schedule instances" description: This is a search type parameters: - name: date in: query description: Search for Schedule resources that have a period that contains this date specified style: simple - name: identifier in: query description: A Schedule Identifier style: simple - name: specialty in: query description: Type of specialty needed style: simple - name: service-category in: query description: High-level category style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: service-type in: query description: The type of appointments that can be booked into associated slot(s) style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Is the schedule in active use style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: actor in: query description: "The individual(HealthcareService, Practitioner, Location, ...)\ \ to find a Schedule for" style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: A Schedule Identifier style: simple - name: specialty in: query description: Type of specialty needed style: simple - name: service-category in: query description: High-level category style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: service-type in: query description: The type of appointments that can be booked into associated slot(s) style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Is the schedule in active use style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: actor in: query description: "The individual(HealthcareService, Practitioner, Location, ...)\ \ to find a Schedule for" style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Schedule/$validate: get: tags: - Schedule parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Schedule requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Schedule/{id}/$validate: get: tags: - Schedule parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Schedule parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Schedule/{id}/$meta-delete: post: tags: - Schedule description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Schedule/{id}/$meta-add: post: tags: - Schedule description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Schedule/$meta: get: tags: - Schedule 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Schedule 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Schedule/{id}/$meta: get: tags: - Schedule description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Schedule description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Schedule/$expunge: post: tags: - Schedule requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Schedule/{id}/$expunge: post: tags: - Schedule parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: code in: query description: Code used in URL style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - name: derived-from in: query description: Original definition for the search parameter style: simple - 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" style: simple - name: type in: query description: number | date | string | token | reference | composite | quantity | uri | special style: simple - name: context-quantity in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - name: target in: query description: Types of resource (if a resource reference) style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: component in: query description: Defines how the part works style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple - name: base in: query description: The resource type(s) this search parameter applies to style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: code in: query description: Code used in URL style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - name: derived-from in: query description: Original definition for the search parameter style: simple - 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" style: simple - name: type in: query description: number | date | string | token | reference | composite | quantity | uri | special style: simple - name: context-quantity in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - name: target in: query description: Types of resource (if a resource reference) style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: component in: query description: Defines how the part works style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple - name: base in: query description: The resource type(s) this search parameter applies to style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/$validate: get: tags: - SearchParameter parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SearchParameter requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/{id}/$validate: get: tags: - SearchParameter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SearchParameter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/{id}/$meta-delete: post: tags: - SearchParameter description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/{id}/$meta-add: post: tags: - SearchParameter description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/$meta: get: tags: - SearchParameter 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SearchParameter 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/{id}/$meta: get: tags: - SearchParameter description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SearchParameter description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/$expunge: post: tags: - SearchParameter requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SearchParameter/{id}/$expunge: post: tags: - SearchParameter parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ServiceRequest: get: tags: - ServiceRequest summary: "search-type: Search for ServiceRequest instances" description: This is a search type parameters: - name: authored in: query description: Date request signed style: simple - name: code in: query description: "Multiple Resources: \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" style: simple - name: requisition in: query description: Composite Request ID style: simple - name: subject in: query description: Search by subject style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: occurrence in: query description: When service should occur style: simple - name: based-on in: query description: What request fulfills style: simple - name: 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" style: simple - name: specimen in: query description: Specimen to be tested style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - name: requester in: query description: Who/what is requesting service style: simple - name: identifier in: query description: "Multiple Resources: \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" style: simple - name: performer in: query description: Requested performer style: simple - name: replaces in: query description: What request replaces style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: priority in: query description: routine | urgent | asap | stat style: simple - name: intent in: query description: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option style: simple - name: performer-type in: query description: Performer role style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: body-site in: query description: Where procedure is going to be done style: simple - name: category in: query description: Classification of service style: simple - name: status in: query description: draft | active | on-hold | revoked | completed | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - 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" style: simple - name: requisition in: query description: Composite Request ID style: simple - name: subject in: query description: Search by subject style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: occurrence in: query description: When service should occur style: simple - name: based-on in: query description: What request fulfills style: simple - name: 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" style: simple - name: specimen in: query description: Specimen to be tested style: simple - name: instantiates-uri in: query description: Instantiates external protocol or definition style: simple - name: requester in: query description: Who/what is requesting service style: simple - name: identifier in: query description: "Multiple Resources: \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" style: simple - name: performer in: query description: Requested performer style: simple - name: replaces in: query description: What request replaces style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: instantiates-canonical in: query description: Instantiates FHIR protocol or definition style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: priority in: query description: routine | urgent | asap | stat style: simple - name: intent in: query description: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option style: simple - name: performer-type in: query description: Performer role style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: body-site in: query description: Where procedure is going to be done style: simple - name: category in: query description: Classification of service style: simple - name: status in: query description: draft | active | on-hold | revoked | completed | entered-in-error | unknown style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ServiceRequest/$validate: get: tags: - ServiceRequest parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ServiceRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ServiceRequest/{id}/$validate: get: tags: - ServiceRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ServiceRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ServiceRequest/{id}/$meta-delete: post: tags: - ServiceRequest description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ServiceRequest/{id}/$meta-add: post: tags: - ServiceRequest description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ServiceRequest/$meta: get: tags: - ServiceRequest 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ServiceRequest 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ServiceRequest/{id}/$meta: get: tags: - ServiceRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ServiceRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ServiceRequest/$expunge: post: tags: - ServiceRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ServiceRequest/{id}/$expunge: post: tags: - ServiceRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Slot: get: tags: - Slot summary: "search-type: Search for Slot instances" description: This is a search type parameters: - name: identifier in: query description: A Slot Identifier style: simple - name: specialty in: query description: The specialty of a practitioner that would be required to perform the service requested in this appointment style: simple - name: service-category in: query description: A broad categorization of the service that is to be performed during this appointment style: simple - name: appointment-type in: query description: The style of appointment or patient that may be booked in the slot (not service type) style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: service-type in: query description: The type of appointments that can be booked into the slot style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: start in: query description: Appointment date/time. style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: schedule in: query description: The Schedule Resource that we are seeking a slot within style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The free/busy status of the appointment style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: specialty in: query description: The specialty of a practitioner that would be required to perform the service requested in this appointment style: simple - name: service-category in: query description: A broad categorization of the service that is to be performed during this appointment style: simple - name: appointment-type in: query description: The style of appointment or patient that may be booked in the slot (not service type) style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: service-type in: query description: The type of appointments that can be booked into the slot style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: start in: query description: Appointment date/time. style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: schedule in: query description: The Schedule Resource that we are seeking a slot within style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The free/busy status of the appointment style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Slot/$validate: get: tags: - Slot parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Slot requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Slot/{id}/$validate: get: tags: - Slot parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Slot parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Slot/{id}/$meta-delete: post: tags: - Slot description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Slot/{id}/$meta-add: post: tags: - Slot description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Slot/$meta: get: tags: - Slot 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Slot 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Slot/{id}/$meta: get: tags: - Slot description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Slot description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Slot/$expunge: post: tags: - Slot requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Slot/{id}/$expunge: post: tags: - Slot parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: container-id in: query description: The unique identifier associated with the specimen container style: simple - name: identifier in: query description: The unique identifier associated with the specimen style: simple - name: parent in: query description: The parent of the specimen style: simple - name: bodysite in: query description: The code for the body site from where the specimen originated style: simple - name: subject in: query description: The subject of the specimen style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: collected in: query description: The date the specimen was collected style: simple - name: accession in: query description: The accession number associated with the specimen style: simple - name: type in: query description: The specimen type style: simple - name: collector in: query description: Who collected the specimen style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The patient the specimen comes from style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: available | unavailable | unsatisfactory | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: container-id in: query description: The unique identifier associated with the specimen container style: simple - name: identifier in: query description: The unique identifier associated with the specimen style: simple - name: parent in: query description: The parent of the specimen style: simple - name: bodysite in: query description: The code for the body site from where the specimen originated style: simple - name: subject in: query description: The subject of the specimen style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: collected in: query description: The date the specimen was collected style: simple - name: accession in: query description: The accession number associated with the specimen style: simple - name: type in: query description: The specimen type style: simple - name: collector in: query description: Who collected the specimen style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: The patient the specimen comes from style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: available | unavailable | unsatisfactory | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Specimen/$validate: get: tags: - Specimen parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Specimen requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Specimen/{id}/$validate: get: tags: - Specimen parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Specimen parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Specimen/{id}/$meta-delete: post: tags: - Specimen description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Specimen/{id}/$meta-add: post: tags: - Specimen description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Specimen/$meta: get: tags: - Specimen 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Specimen 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Specimen/{id}/$meta: get: tags: - Specimen description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Specimen description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Specimen/$expunge: post: tags: - Specimen requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Specimen/{id}/$expunge: post: tags: - Specimen parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SpecimenDefinition: get: tags: - SpecimenDefinition summary: "search-type: Search for SpecimenDefinition instances" description: This is a search type parameters: - name: container in: query description: The type of specimen conditioned in container expected by the lab style: simple - name: identifier in: query description: The unique identifier associated with the specimen style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: The type of collected specimen style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: identifier in: query description: The unique identifier associated with the specimen style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: The type of collected specimen style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SpecimenDefinition/$validate: get: tags: - SpecimenDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SpecimenDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SpecimenDefinition/{id}/$validate: get: tags: - SpecimenDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SpecimenDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SpecimenDefinition/{id}/$meta-delete: post: tags: - SpecimenDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SpecimenDefinition/{id}/$meta-add: post: tags: - SpecimenDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SpecimenDefinition/$meta: get: tags: - SpecimenDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SpecimenDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SpecimenDefinition/{id}/$meta: get: tags: - SpecimenDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SpecimenDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SpecimenDefinition/$expunge: post: tags: - SpecimenDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SpecimenDefinition/{id}/$expunge: post: tags: - SpecimenDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: experimental in: query description: "For testing purposes, not real usage" style: simple - 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" style: simple - name: type in: query description: Type defined or constrained by this structure style: simple - 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" style: simple - name: path in: query description: A path that is constrained in the StructureDefinition style: simple - 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" style: simple - name: base-path in: query description: Path that identifies the base element style: simple - name: keyword in: query description: A code for the StructureDefinition style: simple - name: context-type-quantity in: query description: "Multiple Resources: \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" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [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" style: simple - name: valueset in: query description: A vocabulary binding reference style: simple - name: kind in: query description: primitive-type | complex-type | resource | logical style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: abstract in: query description: Whether the structure is abstract style: simple - name: version in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: ext-context in: query description: "The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: derivation in: query description: specialization | constraint - How relates to base definition style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple - name: base in: query description: Definition that this type is constrained/specialized from style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: experimental in: query description: "For testing purposes, not real usage" style: simple - 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" style: simple - name: type in: query description: Type defined or constrained by this structure style: simple - 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" style: simple - name: path in: query description: A path that is constrained in the StructureDefinition style: simple - 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" style: simple - name: base-path in: query description: Path that identifies the base element style: simple - name: keyword in: query description: A code for the StructureDefinition style: simple - name: context-type-quantity in: query description: "Multiple Resources: \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" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [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" style: simple - name: valueset in: query description: A vocabulary binding reference style: simple - name: kind in: query description: primitive-type | complex-type | resource | logical style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: abstract in: query description: Whether the structure is abstract style: simple - name: version in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: ext-context in: query description: "The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: derivation in: query description: specialization | constraint - How relates to base definition style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple - name: base in: query description: Definition that this type is constrained/specialized from style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/$validate: get: tags: - StructureDefinition parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/$validate: get: tags: - StructureDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/$meta-delete: post: tags: - StructureDefinition description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/$meta-add: post: tags: - StructureDefinition description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/$meta: get: tags: - StructureDefinition 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureDefinition 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/$meta: get: tags: - StructureDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureDefinition description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/$expunge: post: tags: - StructureDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/$expunge: post: tags: - StructureDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/$snapshot: get: tags: - StructureDefinition parameters: - name: url in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureDefinition requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureDefinition/{id}/$snapshot: get: tags: - StructureDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: url in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureDefinition parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureMap/$validate: get: tags: - StructureMap parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureMap requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureMap/{id}/$validate: get: tags: - StructureMap parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureMap parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureMap/{id}/$meta-delete: post: tags: - StructureMap description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureMap/{id}/$meta-add: post: tags: - StructureMap description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureMap/$meta: get: tags: - StructureMap 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureMap 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureMap/{id}/$meta: get: tags: - StructureMap description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - StructureMap description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureMap/$expunge: post: tags: - StructureMap requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /StructureMap/{id}/$expunge: post: tags: - StructureMap parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: The type of channel for the sent notifications style: simple - name: url in: query description: The uri that will receive the notifications style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: payload in: query description: The mime-type of the notification payload style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: contact in: query description: Contact details for the subscription style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current state of the subscription style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: type in: query description: The type of channel for the sent notifications style: simple - name: url in: query description: The uri that will receive the notifications style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: payload in: query description: The mime-type of the notification payload style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: contact in: query description: Contact details for the subscription style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current state of the subscription style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Subscription/$trigger-subscription: post: tags: - Subscription requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Subscription/{id}/$trigger-subscription: post: tags: - Subscription parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Subscription/$validate: get: tags: - Subscription parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Subscription requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Subscription/{id}/$validate: get: tags: - Subscription parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Subscription parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Subscription/{id}/$meta-delete: post: tags: - Subscription description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Subscription/{id}/$meta-add: post: tags: - Subscription description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Subscription/$meta: get: tags: - Subscription 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Subscription 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Subscription/{id}/$meta: get: tags: - Subscription description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Subscription description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Subscription/$expunge: post: tags: - Subscription requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Subscription/{id}/$expunge: post: tags: - Subscription parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Substance: get: tags: - Substance summary: "search-type: Search for Substance instances" description: This is a search type parameters: - name: identifier in: query description: Unique identifier for the substance style: simple - name: container-identifier in: query description: Identifier of the package/container style: simple - name: code in: query description: The code of the substance or ingredient style: simple - name: quantity in: query description: Amount of substance in the package style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: substance-reference in: query description: A component of the substance style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: expiry in: query description: Expiry date of package or container of substance style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: The category of the substance style: simple - name: status in: query description: active | inactive | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: container-identifier in: query description: Identifier of the package/container style: simple - name: code in: query description: The code of the substance or ingredient style: simple - name: quantity in: query description: Amount of substance in the package style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: substance-reference in: query description: A component of the substance style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: expiry in: query description: Expiry date of package or container of substance style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: The category of the substance style: simple - name: status in: query description: active | inactive | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Substance/$validate: get: tags: - Substance parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Substance requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Substance/{id}/$validate: get: tags: - Substance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Substance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Substance/{id}/$meta-delete: post: tags: - Substance description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Substance/{id}/$meta-add: post: tags: - Substance description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Substance/$meta: get: tags: - Substance 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Substance 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Substance/{id}/$meta: get: tags: - Substance description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Substance description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Substance/$expunge: post: tags: - Substance requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Substance/{id}/$expunge: post: tags: - Substance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceNucleicAcid: get: tags: - SubstanceNucleicAcid summary: "search-type: Search for SubstanceNucleicAcid instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceNucleicAcid/_search: get: tags: - SubstanceNucleicAcid summary: "search-type: Search for SubstanceNucleicAcid instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceNucleicAcid/$validate: get: tags: - SubstanceNucleicAcid parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceNucleicAcid requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceNucleicAcid/{id}/$validate: get: tags: - SubstanceNucleicAcid parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceNucleicAcid parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceNucleicAcid/{id}/$meta-delete: post: tags: - SubstanceNucleicAcid description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceNucleicAcid/{id}/$meta-add: post: tags: - SubstanceNucleicAcid description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceNucleicAcid/$meta: get: tags: - SubstanceNucleicAcid 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceNucleicAcid 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceNucleicAcid/{id}/$meta: get: tags: - SubstanceNucleicAcid description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceNucleicAcid description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceNucleicAcid/$expunge: post: tags: - SubstanceNucleicAcid requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceNucleicAcid/{id}/$expunge: post: tags: - SubstanceNucleicAcid parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstancePolymer: get: tags: - SubstancePolymer summary: "search-type: Search for SubstancePolymer instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstancePolymer/_search: get: tags: - SubstancePolymer summary: "search-type: Search for SubstancePolymer instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstancePolymer/$validate: get: tags: - SubstancePolymer parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstancePolymer requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstancePolymer/{id}/$validate: get: tags: - SubstancePolymer parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstancePolymer parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstancePolymer/{id}/$meta-delete: post: tags: - SubstancePolymer description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstancePolymer/{id}/$meta-add: post: tags: - SubstancePolymer description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstancePolymer/$meta: get: tags: - SubstancePolymer 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstancePolymer 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstancePolymer/{id}/$meta: get: tags: - SubstancePolymer description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstancePolymer description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstancePolymer/$expunge: post: tags: - SubstancePolymer requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstancePolymer/{id}/$expunge: post: tags: - SubstancePolymer parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceProtein: get: tags: - SubstanceProtein summary: "search-type: Search for SubstanceProtein instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceProtein/_search: get: tags: - SubstanceProtein summary: "search-type: Search for SubstanceProtein instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceProtein/$validate: get: tags: - SubstanceProtein parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceProtein requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceProtein/{id}/$validate: get: tags: - SubstanceProtein parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceProtein parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceProtein/{id}/$meta-delete: post: tags: - SubstanceProtein description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceProtein/{id}/$meta-add: post: tags: - SubstanceProtein description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceProtein/$meta: get: tags: - SubstanceProtein 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceProtein 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceProtein/{id}/$meta: get: tags: - SubstanceProtein description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceProtein description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceProtein/$expunge: post: tags: - SubstanceProtein requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceProtein/{id}/$expunge: post: tags: - SubstanceProtein parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceReferenceInformation: get: tags: - SubstanceReferenceInformation summary: "search-type: Search for SubstanceReferenceInformation instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceReferenceInformation/_search: get: tags: - SubstanceReferenceInformation summary: "search-type: Search for SubstanceReferenceInformation instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceReferenceInformation/$validate: get: tags: - SubstanceReferenceInformation parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceReferenceInformation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceReferenceInformation/{id}/$validate: get: tags: - SubstanceReferenceInformation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceReferenceInformation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceReferenceInformation/{id}/$meta-delete: post: tags: - SubstanceReferenceInformation description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceReferenceInformation/{id}/$meta-add: post: tags: - SubstanceReferenceInformation description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceReferenceInformation/$meta: get: tags: - SubstanceReferenceInformation 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceReferenceInformation 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceReferenceInformation/{id}/$meta: get: tags: - SubstanceReferenceInformation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceReferenceInformation description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceReferenceInformation/$expunge: post: tags: - SubstanceReferenceInformation requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceReferenceInformation/{id}/$expunge: post: tags: - SubstanceReferenceInformation parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSourceMaterial: get: tags: - SubstanceSourceMaterial summary: "search-type: Search for SubstanceSourceMaterial instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSourceMaterial/_search: get: tags: - SubstanceSourceMaterial summary: "search-type: Search for SubstanceSourceMaterial instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSourceMaterial/$validate: get: tags: - SubstanceSourceMaterial parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceSourceMaterial requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSourceMaterial/{id}/$validate: get: tags: - SubstanceSourceMaterial parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceSourceMaterial parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSourceMaterial/{id}/$meta-delete: post: tags: - SubstanceSourceMaterial description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSourceMaterial/{id}/$meta-add: post: tags: - SubstanceSourceMaterial description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSourceMaterial/$meta: get: tags: - SubstanceSourceMaterial 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceSourceMaterial 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSourceMaterial/{id}/$meta: get: tags: - SubstanceSourceMaterial description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceSourceMaterial description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSourceMaterial/$expunge: post: tags: - SubstanceSourceMaterial requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSourceMaterial/{id}/$expunge: post: tags: - SubstanceSourceMaterial parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSpecification: get: tags: - SubstanceSpecification summary: "search-type: Search for SubstanceSpecification instances" description: This is a search type parameters: - name: code in: query description: The specific code style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSpecification/_search: get: tags: - SubstanceSpecification summary: "search-type: Search for SubstanceSpecification instances" description: This is a search type parameters: - name: code in: query description: The specific code style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSpecification/$validate: get: tags: - SubstanceSpecification parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceSpecification requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSpecification/{id}/$validate: get: tags: - SubstanceSpecification parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceSpecification parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSpecification/{id}/$meta-delete: post: tags: - SubstanceSpecification description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSpecification/{id}/$meta-add: post: tags: - SubstanceSpecification description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSpecification/$meta: get: tags: - SubstanceSpecification 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceSpecification 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSpecification/{id}/$meta: get: tags: - SubstanceSpecification description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SubstanceSpecification description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSpecification/$expunge: post: tags: - SubstanceSpecification requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SubstanceSpecification/{id}/$expunge: post: tags: - SubstanceSpecification parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: receiver in: query description: Who collected the Supply style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: supplier in: query description: Dispenser style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: in-progress | completed | abandoned | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: receiver in: query description: Who collected the Supply style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: supplier in: query description: Dispenser style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: in-progress | completed | abandoned | entered-in-error style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyDelivery/$validate: get: tags: - SupplyDelivery parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SupplyDelivery requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyDelivery/{id}/$validate: get: tags: - SupplyDelivery parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SupplyDelivery parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyDelivery/{id}/$meta-delete: post: tags: - SupplyDelivery description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyDelivery/{id}/$meta-add: post: tags: - SupplyDelivery description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyDelivery/$meta: get: tags: - SupplyDelivery 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SupplyDelivery 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyDelivery/{id}/$meta: get: tags: - SupplyDelivery description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SupplyDelivery description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyDelivery/$expunge: post: tags: - SupplyDelivery requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyDelivery/{id}/$expunge: post: tags: - SupplyDelivery parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: requester in: query description: Individual making the request style: simple - 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" style: simple - name: subject in: query description: The destination of the supply style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: supplier in: query description: Who is intended to fulfill the request style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: "The kind of supply (central, non-stock, etc.)" style: simple - name: status in: query description: draft | active | suspended + style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: requester in: query description: Individual making the request style: simple - 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" style: simple - name: subject in: query description: The destination of the supply style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: supplier in: query description: Who is intended to fulfill the request style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: category in: query description: "The kind of supply (central, non-stock, etc.)" style: simple - name: status in: query description: draft | active | suspended + style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyRequest/$validate: get: tags: - SupplyRequest parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SupplyRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyRequest/{id}/$validate: get: tags: - SupplyRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SupplyRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyRequest/{id}/$meta-delete: post: tags: - SupplyRequest description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyRequest/{id}/$meta-add: post: tags: - SupplyRequest description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyRequest/$meta: get: tags: - SupplyRequest 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SupplyRequest 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyRequest/{id}/$meta: get: tags: - SupplyRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - SupplyRequest description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyRequest/$expunge: post: tags: - SupplyRequest requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /SupplyRequest/{id}/$expunge: post: tags: - SupplyRequest parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Task: get: tags: - Task summary: "search-type: Search for Task instances" description: This is a search type parameters: - name: code in: query description: Search by task code style: simple - name: subject in: query description: Search by subject style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: focus in: query description: Search by task focus style: simple - name: part-of in: query description: Search by task this task is part of style: simple - name: group-identifier in: query description: Search by group identifier style: simple - name: based-on in: query description: Search by requests this task is based on style: simple - name: patient in: query description: Search by patient style: simple - name: modified in: query description: Search by last modification date style: simple - name: owner in: query description: Search by task owner style: simple - name: requester in: query description: Search by task requester style: simple - name: business-status in: query description: Search by business status style: simple - name: identifier in: query description: Search for a task instance by its business identifier style: simple - name: period in: query description: Search by period Task is/was underway style: simple - name: performer in: query description: "Search by recommended type of performer (e.g., Requester, Performer,\ \ Scheduler)." style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Search by encounter style: simple - name: authored-on in: query description: Search by creation date style: simple - name: priority in: query description: Search by task priority style: simple - name: intent in: query description: Search by task intent style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Search by task status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: subject in: query description: Search by subject style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: focus in: query description: Search by task focus style: simple - name: part-of in: query description: Search by task this task is part of style: simple - name: group-identifier in: query description: Search by group identifier style: simple - name: based-on in: query description: Search by requests this task is based on style: simple - name: patient in: query description: Search by patient style: simple - name: modified in: query description: Search by last modification date style: simple - name: owner in: query description: Search by task owner style: simple - name: requester in: query description: Search by task requester style: simple - name: business-status in: query description: Search by business status style: simple - name: identifier in: query description: Search for a task instance by its business identifier style: simple - name: period in: query description: Search by period Task is/was underway style: simple - name: performer in: query description: "Search by recommended type of performer (e.g., Requester, Performer,\ \ Scheduler)." style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: Search by encounter style: simple - name: authored-on in: query description: Search by creation date style: simple - name: priority in: query description: Search by task priority style: simple - name: intent in: query description: Search by task intent style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Search by task status style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Task/$validate: get: tags: - Task parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Task requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Task/{id}/$validate: get: tags: - Task parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Task parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Task/{id}/$meta-delete: post: tags: - Task description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Task/{id}/$meta-add: post: tags: - Task description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Task/$meta: get: tags: - Task 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Task 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Task/{id}/$meta: get: tags: - Task description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Task description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Task/$expunge: post: tags: - Task requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Task/{id}/$expunge: post: tags: - Task parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: context-quantity in: query description: "Multiple Resources: \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" style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: context in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: context-type-quantity in: query description: "Multiple Resources: \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" style: simple - 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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: context-quantity in: query description: "Multiple Resources: \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" style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: context in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: context-type-quantity in: query description: "Multiple Resources: \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" style: simple - 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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TerminologyCapabilities/$validate: get: tags: - TerminologyCapabilities parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - TerminologyCapabilities requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TerminologyCapabilities/{id}/$validate: get: tags: - TerminologyCapabilities parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - TerminologyCapabilities parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TerminologyCapabilities/{id}/$meta-delete: post: tags: - TerminologyCapabilities description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TerminologyCapabilities/{id}/$meta-add: post: tags: - TerminologyCapabilities description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TerminologyCapabilities/$meta: get: tags: - TerminologyCapabilities 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - TerminologyCapabilities 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TerminologyCapabilities/{id}/$meta: get: tags: - TerminologyCapabilities description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - TerminologyCapabilities description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TerminologyCapabilities/$expunge: post: tags: - TerminologyCapabilities requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TerminologyCapabilities/{id}/$expunge: post: tags: - TerminologyCapabilities parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestReport: get: tags: - TestReport summary: "search-type: Search for TestReport instances" description: This is a search type parameters: - name: identifier in: query description: An external identifier for the test report style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: tester in: query description: The name of the testing organization style: simple - name: participant in: query description: The reference to a participant in the test execution style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: result in: query description: The result disposition of the test execution style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: testscript in: query description: The test script executed to produce this report style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: issued in: query description: The test report generation date style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: tester in: query description: The name of the testing organization style: simple - name: participant in: query description: The reference to a participant in the test execution style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: result in: query description: The result disposition of the test execution style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: testscript in: query description: The test script executed to produce this report style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: issued in: query description: The test report generation date style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestReport/$validate: get: tags: - TestReport parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - TestReport requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestReport/{id}/$validate: get: tags: - TestReport parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - TestReport parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestReport/{id}/$meta-delete: post: tags: - TestReport description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestReport/{id}/$meta-add: post: tags: - TestReport description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestReport/$meta: get: tags: - TestReport 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - TestReport 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestReport/{id}/$meta: get: tags: - TestReport description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - TestReport description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestReport/$expunge: post: tags: - TestReport requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestReport/{id}/$expunge: post: tags: - TestReport parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestScript: get: tags: - TestScript summary: "search-type: Search for TestScript instances" description: This is a search type parameters: - name: date in: query description: The test script publication date style: simple - name: context-type-value in: query description: A use context type and value assigned to the test script style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the test script style: simple - name: description in: query description: The description of the test script style: simple - name: testscript-capability in: query description: TestScript required and validated capability style: simple - name: context-type in: query description: A type of use context assigned to the test script style: simple - name: title in: query description: The human-friendly name of the test script style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the test script style: simple - name: context in: query description: A use context assigned to the test script style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the test script style: simple - name: identifier in: query description: External identifier for the test script style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the test script style: simple - name: url in: query description: The uri that identifies the test script style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the test script style: simple - name: publisher in: query description: Name of the publisher of the test script style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the test script style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - name: context-type-value in: query description: A use context type and value assigned to the test script style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: jurisdiction in: query description: Intended jurisdiction for the test script style: simple - name: description in: query description: The description of the test script style: simple - name: testscript-capability in: query description: TestScript required and validated capability style: simple - name: context-type in: query description: A type of use context assigned to the test script style: simple - name: title in: query description: The human-friendly name of the test script style: simple - name: context-quantity in: query description: A quantity- or range-valued use context assigned to the test script style: simple - name: context in: query description: A use context assigned to the test script style: simple - name: context-type-quantity in: query description: A use context type and quantity- or range-based value assigned to the test script style: simple - name: identifier in: query description: External identifier for the test script style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: version in: query description: The business version of the test script style: simple - name: url in: query description: The uri that identifies the test script style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: Computationally friendly name of the test script style: simple - name: publisher in: query description: Name of the publisher of the test script style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The current status of the test script style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestScript/$validate: get: tags: - TestScript parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - TestScript requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestScript/{id}/$validate: get: tags: - TestScript parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - TestScript parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestScript/{id}/$meta-delete: post: tags: - TestScript description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestScript/{id}/$meta-add: post: tags: - TestScript description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestScript/$meta: get: tags: - TestScript 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - TestScript 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestScript/{id}/$meta: get: tags: - TestScript description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - TestScript description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestScript/$expunge: post: tags: - TestScript requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /TestScript/{id}/$expunge: post: tags: - TestScript parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: code in: query description: This special parameter searches for codes in the value set. See additional notes on the ValueSet resource style: simple - name: context-type-value in: query description: "Multiple Resources: \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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: reference in: query description: A code system included or excluded in the value set or an imported value set style: simple - name: context-quantity in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - name: expansion in: query description: Identifies the value set expansion (business identifier) style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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" style: simple - name: code in: query description: This special parameter searches for codes in the value set. See additional notes on the ValueSet resource style: simple - name: context-type-value in: query description: "Multiple Resources: \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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - 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" style: simple - 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" style: simple - 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" style: simple - 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" style: simple - name: reference in: query description: A code system included or excluded in the value set or an imported value set style: simple - name: context-quantity in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - 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" style: simple - name: identifier in: query description: "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html):\ \ External identifier for the code system\r\n* [ConceptMap](conceptmap.html):\ \ External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html):\ \ External identifier for the message definition\r\n* [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" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - 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" style: simple - 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" style: simple - name: expansion in: query description: Identifies the value set expansion (business identifier) style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: name in: query description: "Multiple Resources: \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" style: simple - 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" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: "Multiple Resources: \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" style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/$validate-code: get: tags: - ValueSet parameters: - name: url in: query required: false style: simple - name: version in: query required: false style: simple - name: code in: query required: false style: simple - name: display in: query required: false style: simple - name: coding in: query required: false style: simple - name: valueSetVersion in: query required: false style: simple - name: system in: query required: false style: simple - name: systemVersion in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ValueSet requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/{id}/$validate-code: get: tags: - ValueSet parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: url in: query required: false style: simple - name: version in: query required: false style: simple - name: code in: query required: false style: simple - name: display in: query required: false style: simple - name: coding in: query required: false style: simple - name: valueSetVersion in: query required: false style: simple - name: system in: query required: false style: simple - name: systemVersion in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ValueSet parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/{id}/$invalidate-expansion: post: tags: - ValueSet parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/$expand: get: tags: - ValueSet parameters: - name: url in: query required: false style: simple - name: valueSetVersion in: query required: false style: simple - name: filter in: query required: false style: simple - name: context in: query required: false style: simple - name: contextDirection in: query required: false style: simple - name: offset in: query required: false style: simple - name: count in: query required: false style: simple - name: displayLanguage in: query required: false style: simple - name: includeHierarchy in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ValueSet requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/{id}/$expand: get: tags: - ValueSet parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: url in: query required: false style: simple - name: valueSetVersion in: query required: false style: simple - name: filter in: query required: false style: simple - name: context in: query required: false style: simple - name: contextDirection in: query required: false style: simple - name: offset in: query required: false style: simple - name: count in: query required: false style: simple - name: displayLanguage in: query required: false style: simple - name: includeHierarchy in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ValueSet parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/$validate: get: tags: - ValueSet parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ValueSet requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/{id}/$validate: get: tags: - ValueSet parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ValueSet parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/{id}/$meta-delete: post: tags: - ValueSet description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/{id}/$meta-add: post: tags: - ValueSet description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/$meta: get: tags: - ValueSet 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ValueSet 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/{id}/$meta: get: tags: - ValueSet description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - ValueSet description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/$expunge: post: tags: - ValueSet requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /ValueSet/{id}/$expunge: post: tags: - ValueSet parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VerificationResult: get: tags: - VerificationResult summary: "search-type: Search for VerificationResult instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: target in: query description: A resource that was validated style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VerificationResult/_search: get: tags: - VerificationResult summary: "search-type: Search for VerificationResult instances" description: This is a search type parameters: - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: target in: query description: A resource that was validated style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VerificationResult/$validate: get: tags: - VerificationResult parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - VerificationResult requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VerificationResult/{id}/$validate: get: tags: - VerificationResult parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - VerificationResult parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VerificationResult/{id}/$meta-delete: post: tags: - VerificationResult description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VerificationResult/{id}/$meta-add: post: tags: - VerificationResult description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VerificationResult/$meta: get: tags: - VerificationResult 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - VerificationResult 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VerificationResult/{id}/$meta: get: tags: - VerificationResult description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - VerificationResult description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VerificationResult/$expunge: post: tags: - VerificationResult requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VerificationResult/{id}/$expunge: post: tags: - VerificationResult parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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: null example: "123" requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: |- { "resourceType": "Parameters", "parameter": [ { "name": "operation", "part": [ { "name": "type", "valueString": "add" }, { "name": "path", "valueString": "Patient" }, { "name": "name", "valueString": "birthDate" }, { "name": "value", "valueDate": "1930-01-01" } ] } ] } application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: |- responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: "1" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VisionPrescription: get: tags: - VisionPrescription summary: "search-type: Search for VisionPrescription instances" description: This is a search type parameters: - name: prescriber in: query description: Who authorized the vision prescription style: simple - name: identifier in: query description: "Multiple Resources: \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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: datewritten in: query description: Return prescriptions written on this date style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the vision prescription style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /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 style: simple - 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" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: datewritten in: query description: Return prescriptions written on this date style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: encounter in: query description: "Multiple Resources: \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" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: patient in: query description: "Multiple Resources: \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" style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: The status of the vision prescription style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VisionPrescription/$validate: get: tags: - VisionPrescription parameters: - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - VisionPrescription requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VisionPrescription/{id}/$validate: get: tags: - VisionPrescription parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" - name: mode in: query required: false style: simple responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - VisionPrescription parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VisionPrescription/{id}/$meta-delete: post: tags: - VisionPrescription description: "Delete tags, profiles, and/or security labels from a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VisionPrescription/{id}/$meta-add: post: tags: - VisionPrescription description: "Add tags, profiles, and/or security labels to a resource" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "meta" } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VisionPrescription/$meta: get: tags: - VisionPrescription 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' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - VisionPrescription 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: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VisionPrescription/{id}/$meta: get: tags: - VisionPrescription description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - VisionPrescription description: "Request a list of tags, profiles, and security labels for a specfic\ \ resource instance" parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters" } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VisionPrescription/$expunge: post: tags: - VisionPrescription requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /VisionPrescription/{id}/$expunge: post: tags: - VisionPrescription parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: "123" requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: |- { "resourceType": "Parameters", "parameter": [ { "name": "limit", "valueInteger": 0 }, { "name": "expungeDeletedResources", "valueBoolean": false }, { "name": "expungePreviousVersions", "valueBoolean": false }, { "name": "expungeEverything", "valueBoolean": false } ] } responses: "200": description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null components: schemas: FHIR-JSON-RESOURCE: type: object description: A FHIR resource example: null FHIR-XML-RESOURCE: type: object description: A FHIR resource example: null