Class AsynchronousClient<CTX>

Type Parameters

Implements

FHIRClientAsync<CTX>

Constructors

constructor

new AsynchronousClient<CTX>(
middleware: MiddlewareAsync<CTX>,
): AsynchronousClient<CTX>
Type Parameters
- CTX
Parameters
- middleware: MiddlewareAsync<CTX>
Returns AsynchronousClient<CTX>
- Defined in packages/client/src/index.ts:24

Accessors

middleware

get middleware(): MiddlewareAsync<CTX>
Returns MiddlewareAsync<CTX>
Implementation of FHIRClientAsync.middleware
- Defined in packages/client/src/index.ts:28

Methods

batch

batch<FHIRVersion extends "4.0" | "4.3">(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    bundle: Resource<FHIRVersion, "Bundle">,
): Promise<Resource<FHIRVersion, "Bundle">>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- bundle: Resource<FHIRVersion, "Bundle">
Returns Promise<Resource<FHIRVersion, "Bundle">>
Implementation of FHIRClientAsync.batch
- Defined in packages/client/src/index.ts:532

capabilities

capabilities<FHIRVersion extends "4.0" | "4.3">(
ctx: CTX,
fhirVersion: FHIRVersion,
): Promise<Resource<FHIRVersion, "CapabilityStatement">>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
Returns Promise<Resource<FHIRVersion, "CapabilityStatement">>
Implementation of FHIRClientAsync.capabilities
- Defined in packages/client/src/index.ts:46

conditionalUpdate

conditionalUpdate<
    FHIRVersion extends "4.0"
    | "4.3",
    T extends

            | "SearchParameter"
            | "Account"
            | "ActivityDefinition"
            | "AdverseEvent"
            | "AllergyIntolerance"
            | "Appointment"
            | "AppointmentResponse"
            | "AuditEvent"
            | "Basic"
            | "Binary"
            | "BiologicallyDerivedProduct"
            | "BodyStructure"
            | "Bundle"
            | "CapabilityStatement"
            | "CarePlan"
            | "CareTeam"
            | "CatalogEntry"
            | "ChargeItem"
            | "ChargeItemDefinition"
            | "Claim"
            | "ClaimResponse"
            | "ClinicalImpression"
            | "CodeSystem"
            | "Communication"
            | "CommunicationRequest"
            | "CompartmentDefinition"
            | "Composition"
            | "ConceptMap"
            | "Condition"
            | "Consent"
            | "Contract"
            | "Coverage"
            | "CoverageEligibilityRequest"
            | "CoverageEligibilityResponse"
            | "DetectedIssue"
            | "Device"
            | "DeviceDefinition"
            | "DeviceMetric"
            | "DeviceRequest"
            | "DeviceUseStatement"
            | "DiagnosticReport"
            | "DocumentManifest"
            | "DocumentReference"
            | "EffectEvidenceSynthesis"
            | "Encounter"
            | "Endpoint"
            | "EnrollmentRequest"
            | "EnrollmentResponse"
            | "EpisodeOfCare"
            | "EventDefinition"
            | "Evidence"
            | "EvidenceVariable"
            | "ExampleScenario"
            | "ExplanationOfBenefit"
            | "FamilyMemberHistory"
            | "Flag"
            | "Goal"
            | "GraphDefinition"
            | "Group"
            | "GuidanceResponse"
            | "HealthcareService"
            | "ImagingStudy"
            | "Immunization"
            | "ImmunizationEvaluation"
            | "ImmunizationRecommendation"
            | "ImplementationGuide"
            | "InsurancePlan"
            | "Invoice"
            | "Library"
            | "Linkage"
            | "List"
            | "Location"
            | "Measure"
            | "MeasureReport"
            | "Media"
            | "Medication"
            | "MedicationAdministration"
            | "MedicationDispense"
            | "MedicationKnowledge"
            | "MedicationRequest"
            | "MedicationStatement"
            | "MedicinalProduct"
            | "MedicinalProductAuthorization"
            | "MedicinalProductContraindication"
            | "MedicinalProductIndication"
            | "MedicinalProductIngredient"
            | "MedicinalProductInteraction"
            | "MedicinalProductManufactured"
            | "MedicinalProductPackaged"
            | "MedicinalProductPharmaceutical"
            | "MedicinalProductUndesirableEffect"
            | "MessageDefinition"
            | "MessageHeader"
            | "MolecularSequence"
            | "NamingSystem"
            | "NutritionOrder"
            | "Observation"
            | "ObservationDefinition"
            | "OperationDefinition"
            | "OperationOutcome"
            | "Organization"
            | "OrganizationAffiliation"
            | "Parameters"
            | "Patient"
            | "PaymentNotice"
            | "PaymentReconciliation"
            | "Person"
            | "PlanDefinition"
            | "Practitioner"
            | "PractitionerRole"
            | "Procedure"
            | "Provenance"
            | "Questionnaire"
            | "QuestionnaireResponse"
            | "RelatedPerson"
            | "RequestGroup"
            | "ResearchDefinition"
            | "ResearchElementDefinition"
            | "ResearchStudy"
            | "ResearchSubject"
            | "RiskAssessment"
            | "RiskEvidenceSynthesis"
            | "Schedule"
            | "ServiceRequest"
            | "Slot"
            | "Specimen"
            | "SpecimenDefinition"
            | "StructureDefinition"
            | "StructureMap"
            | "Subscription"
            | "Substance"
            | "SubstanceNucleicAcid"
            | "SubstancePolymer"
            | "SubstanceProtein"
            | "SubstanceReferenceInformation"
            | "SubstanceSourceMaterial"
            | "SubstanceSpecification"
            | "SupplyDelivery"
            | "SupplyRequest"
            | "Task"
            | "TerminologyCapabilities"
            | "TestReport"
            | "TestScript"
            | "ValueSet"
            | "VerificationResult"
            | "VisionPrescription"
            | "AccessPolicyV2"
            | "ClientApplication"
            | "IdentityProvider"
            | "Membership"
            | "Project"
            | "User"
            | "AdministrableProductDefinition"
            | "Citation"
            | "ClinicalUseDefinition"
            | "EvidenceReport"
            | "Ingredient"
            | "ManufacturedItemDefinition"
            | "MedicinalProductDefinition"
            | "NutritionProduct"
            | "PackagedProductDefinition"
            | "RegulatedAuthorization"
            | "SubscriptionStatus"
            | "SubscriptionTopic"
            | "SubstanceDefinition",
>(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    resourceType: T,
    parameters: string | ParsedParameter<string | number>[],
    resource: Resource<FHIRVersion, T>,
): Promise<Resource<FHIRVersion, T>>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
- T extends
      | "SearchParameter"
      | "Account"
      | "ActivityDefinition"
      | "AdverseEvent"
      | "AllergyIntolerance"
      | "Appointment"
      | "AppointmentResponse"
      | "AuditEvent"
      | "Basic"
      | "Binary"
      | "BiologicallyDerivedProduct"
      | "BodyStructure"
      | "Bundle"
      | "CapabilityStatement"
      | "CarePlan"
      | "CareTeam"
      | "CatalogEntry"
      | "ChargeItem"
      | "ChargeItemDefinition"
      | "Claim"
      | "ClaimResponse"
      | "ClinicalImpression"
      | "CodeSystem"
      | "Communication"
      | "CommunicationRequest"
      | "CompartmentDefinition"
      | "Composition"
      | "ConceptMap"
      | "Condition"
      | "Consent"
      | "Contract"
      | "Coverage"
      | "CoverageEligibilityRequest"
      | "CoverageEligibilityResponse"
      | "DetectedIssue"
      | "Device"
      | "DeviceDefinition"
      | "DeviceMetric"
      | "DeviceRequest"
      | "DeviceUseStatement"
      | "DiagnosticReport"
      | "DocumentManifest"
      | "DocumentReference"
      | "EffectEvidenceSynthesis"
      | "Encounter"
      | "Endpoint"
      | "EnrollmentRequest"
      | "EnrollmentResponse"
      | "EpisodeOfCare"
      | "EventDefinition"
      | "Evidence"
      | "EvidenceVariable"
      | "ExampleScenario"
      | "ExplanationOfBenefit"
      | "FamilyMemberHistory"
      | "Flag"
      | "Goal"
      | "GraphDefinition"
      | "Group"
      | "GuidanceResponse"
      | "HealthcareService"
      | "ImagingStudy"
      | "Immunization"
      | "ImmunizationEvaluation"
      | "ImmunizationRecommendation"
      | "ImplementationGuide"
      | "InsurancePlan"
      | "Invoice"
      | "Library"
      | "Linkage"
      | "List"
      | "Location"
      | "Measure"
      | "MeasureReport"
      | "Media"
      | "Medication"
      | "MedicationAdministration"
      | "MedicationDispense"
      | "MedicationKnowledge"
      | "MedicationRequest"
      | "MedicationStatement"
      | "MedicinalProduct"
      | "MedicinalProductAuthorization"
      | "MedicinalProductContraindication"
      | "MedicinalProductIndication"
      | "MedicinalProductIngredient"
      | "MedicinalProductInteraction"
      | "MedicinalProductManufactured"
      | "MedicinalProductPackaged"
      | "MedicinalProductPharmaceutical"
      | "MedicinalProductUndesirableEffect"
      | "MessageDefinition"
      | "MessageHeader"
      | "MolecularSequence"
      | "NamingSystem"
      | "NutritionOrder"
      | "Observation"
      | "ObservationDefinition"
      | "OperationDefinition"
      | "OperationOutcome"
      | "Organization"
      | "OrganizationAffiliation"
      | "Parameters"
      | "Patient"
      | "PaymentNotice"
      | "PaymentReconciliation"
      | "Person"
      | "PlanDefinition"
      | "Practitioner"
      | "PractitionerRole"
      | "Procedure"
      | "Provenance"
      | "Questionnaire"
      | "QuestionnaireResponse"
      | "RelatedPerson"
      | "RequestGroup"
      | "ResearchDefinition"
      | "ResearchElementDefinition"
      | "ResearchStudy"
      | "ResearchSubject"
      | "RiskAssessment"
      | "RiskEvidenceSynthesis"
      | "Schedule"
      | "ServiceRequest"
      | "Slot"
      | "Specimen"
      | "SpecimenDefinition"
      | "StructureDefinition"
      | "StructureMap"
      | "Subscription"
      | "Substance"
      | "SubstanceNucleicAcid"
      | "SubstancePolymer"
      | "SubstanceProtein"
      | "SubstanceReferenceInformation"
      | "SubstanceSourceMaterial"
      | "SubstanceSpecification"
      | "SupplyDelivery"
      | "SupplyRequest"
      | "Task"
      | "TerminologyCapabilities"
      | "TestReport"
      | "TestScript"
      | "ValueSet"
      | "VerificationResult"
      | "VisionPrescription"
      | "AccessPolicyV2"
      | "ClientApplication"
      | "IdentityProvider"
      | "Membership"
      | "Project"
      | "User"
      | "AdministrableProductDefinition"
      | "Citation"
      | "ClinicalUseDefinition"
      | "EvidenceReport"
      | "Ingredient"
      | "ManufacturedItemDefinition"
      | "MedicinalProductDefinition"
      | "NutritionProduct"
      | "PackagedProductDefinition"
      | "RegulatedAuthorization"
      | "SubscriptionStatus"
      | "SubscriptionTopic"
      | "SubstanceDefinition"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- resourceType: T
- parameters: string | ParsedParameter<string | number>[]
- resource: Resource<FHIRVersion, T>
Returns Promise<Resource<FHIRVersion, T>>
Implementation of FHIRClientAsync.conditionalUpdate
- Defined in packages/client/src/index.ts:138

create

create<
    FHIRVersion extends "4.0"
    | "4.3",
    T extends

            | OperationOutcome
            | OperationDefinition
            | Parameters
            | SearchParameter
            | Account
            | ActivityDefinition
            | AdverseEvent
            | AllergyIntolerance
            | Appointment
            | AppointmentResponse
            | AuditEvent
            | Basic
            | Binary
            | BiologicallyDerivedProduct
            | BodyStructure
            | Bundle
            | CapabilityStatement
            | CarePlan
            | CareTeam
            | CatalogEntry
            | ChargeItem
            | ChargeItemDefinition
            | Claim
            | ClaimResponse
            | ClinicalImpression
            | CodeSystem
            | Communication
            | CommunicationRequest
            | CompartmentDefinition
            | Composition
            | ConceptMap
            | Condition
            | Consent
            | Contract
            | Coverage
            | CoverageEligibilityRequest
            | CoverageEligibilityResponse
            | DetectedIssue
            | Device
            | DeviceDefinition
            | DeviceMetric
            | DeviceRequest
            | DeviceUseStatement
            | DiagnosticReport
            | DocumentManifest
            | DocumentReference
            | EffectEvidenceSynthesis
            | Encounter
            | Endpoint
            | EnrollmentRequest
            | EnrollmentResponse
            | EpisodeOfCare
            | EventDefinition
            | Evidence
            | EvidenceVariable
            | ExampleScenario
            | ExplanationOfBenefit
            | FamilyMemberHistory
            | Flag
            | Goal
            | GraphDefinition
            | Group
            | GuidanceResponse
            | HealthcareService
            | ImagingStudy
            | Immunization
            | ImmunizationEvaluation
            | ImmunizationRecommendation
            | ImplementationGuide
            | InsurancePlan
            | Invoice
            | Library
            | Linkage
            | List
            | Location
            | Measure
            | MeasureReport
            | Media
            | Medication
            | MedicationAdministration
            | MedicationDispense
            | MedicationKnowledge
            | MedicationRequest
            | MedicationStatement
            | MedicinalProduct
            | MedicinalProductAuthorization
            | MedicinalProductContraindication
            | MedicinalProductIndication
            | MedicinalProductIngredient
            | MedicinalProductInteraction
            | MedicinalProductManufactured
            | MedicinalProductPackaged
            | MedicinalProductPharmaceutical
            | MedicinalProductUndesirableEffect
            | MessageDefinition
            | MessageHeader
            | MolecularSequence
            | NamingSystem
            | NutritionOrder
            | Observation
            | ObservationDefinition
            | Organization
            | OrganizationAffiliation
            | Patient
            | PaymentNotice
            | PaymentReconciliation
            | Person
            | PlanDefinition
            | Practitioner
            | PractitionerRole
            | Procedure
            | Provenance
            | Questionnaire
            | QuestionnaireResponse
            | RelatedPerson
            | RequestGroup
            | ResearchDefinition
            | ResearchElementDefinition
            | ResearchStudy
            | ResearchSubject
            | RiskAssessment
            | RiskEvidenceSynthesis
            | Schedule
            | ServiceRequest
            | Slot
            | Specimen
            | SpecimenDefinition
            | StructureDefinition
            | StructureMap
            | Subscription
            | Substance
            | SubstanceNucleicAcid
            | SubstancePolymer
            | SubstanceProtein
            | SubstanceReferenceInformation
            | SubstanceSourceMaterial
            | SubstanceSpecification
            | SupplyDelivery
            | SupplyRequest
            | Task
            | TerminologyCapabilities
            | TestReport
            | TestScript
            | ValueSet
            | VerificationResult
            | VisionPrescription
            | AccessPolicyV2
            | ClientApplication
            | IdentityProvider
            | Membership
            | Project
            | User
            | SearchParameter
            | Account
            | ActivityDefinition
            | AdverseEvent
            | AllergyIntolerance
            | Appointment
            | AppointmentResponse
            | AuditEvent
            | Basic
            | Binary
            | BiologicallyDerivedProduct
            | BodyStructure
            | Bundle
            | CapabilityStatement
            | CarePlan
            | CareTeam
            | CatalogEntry
            | ChargeItem
            | ChargeItemDefinition
            | Claim
            | ClaimResponse
            | ClinicalImpression
            | CodeSystem
            | Communication
            | CommunicationRequest
            | CompartmentDefinition
            | Composition
            | ConceptMap
            | Condition
            | Consent
            | Contract
            | Coverage
            | CoverageEligibilityRequest
            | CoverageEligibilityResponse
            | DetectedIssue
            | Device
            | DeviceDefinition
            | DeviceMetric
            | DeviceRequest
            | DeviceUseStatement
            | DiagnosticReport
            | DocumentManifest
            | DocumentReference
            | Encounter
            | Endpoint
            | EnrollmentRequest
            | EnrollmentResponse
            | EpisodeOfCare
            | EventDefinition
            | Evidence
            | EvidenceVariable
            | ExampleScenario
            | ExplanationOfBenefit
            | FamilyMemberHistory
            | Flag
            | Goal
            | GraphDefinition
            | Group
            | GuidanceResponse
            | HealthcareService
            | ImagingStudy
            | Immunization
            | ImmunizationEvaluation
            | ImmunizationRecommendation
            | ImplementationGuide
            | InsurancePlan
            | Invoice
            | Library
            | Linkage
            | List
            | Location
            | Measure
            | MeasureReport
            | Media
            | Medication
            | MedicationAdministration
            | MedicationDispense
            | MedicationKnowledge
            | MedicationRequest
            | MedicationStatement
            | MessageDefinition
            | MessageHeader
            | MolecularSequence
            | NamingSystem
            | NutritionOrder
            | Observation
            | ObservationDefinition
            | OperationDefinition
            | OperationOutcome
            | Organization
            | OrganizationAffiliation
            | Parameters
            | Patient
            | PaymentNotice
            | PaymentReconciliation
            | Person
            | PlanDefinition
            | Practitioner
            | PractitionerRole
            | Procedure
            | Provenance
            | Questionnaire
            | QuestionnaireResponse
            | RelatedPerson
            | RequestGroup
            | ResearchDefinition
            | ResearchElementDefinition
            | ResearchStudy
            | ResearchSubject
            | RiskAssessment
            | Schedule
            | ServiceRequest
            | Slot
            | Specimen
            | SpecimenDefinition
            | StructureDefinition
            | StructureMap
            | Subscription
            | Substance
            | SupplyDelivery
            | SupplyRequest
            | Task
            | TerminologyCapabilities
            | TestReport
            | TestScript
            | ValueSet
            | VerificationResult
            | VisionPrescription
            | AdministrableProductDefinition
            | Citation
            | ClinicalUseDefinition
            | EvidenceReport
            | Ingredient
            | ManufacturedItemDefinition
            | MedicinalProductDefinition
            | NutritionProduct
            | PackagedProductDefinition
            | RegulatedAuthorization
            | SubscriptionStatus
            | SubscriptionTopic
            | SubstanceDefinition,
>(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    resource: T,
): Promise<T>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
- T extends
      | OperationOutcome
      | OperationDefinition
      | Parameters
      | SearchParameter
      | Account
      | ActivityDefinition
      | AdverseEvent
      | AllergyIntolerance
      | Appointment
      | AppointmentResponse
      | AuditEvent
      | Basic
      | Binary
      | BiologicallyDerivedProduct
      | BodyStructure
      | Bundle
      | CapabilityStatement
      | CarePlan
      | CareTeam
      | CatalogEntry
      | ChargeItem
      | ChargeItemDefinition
      | Claim
      | ClaimResponse
      | ClinicalImpression
      | CodeSystem
      | Communication
      | CommunicationRequest
      | CompartmentDefinition
      | Composition
      | ConceptMap
      | Condition
      | Consent
      | Contract
      | Coverage
      | CoverageEligibilityRequest
      | CoverageEligibilityResponse
      | DetectedIssue
      | Device
      | DeviceDefinition
      | DeviceMetric
      | DeviceRequest
      | DeviceUseStatement
      | DiagnosticReport
      | DocumentManifest
      | DocumentReference
      | EffectEvidenceSynthesis
      | Encounter
      | Endpoint
      | EnrollmentRequest
      | EnrollmentResponse
      | EpisodeOfCare
      | EventDefinition
      | Evidence
      | EvidenceVariable
      | ExampleScenario
      | ExplanationOfBenefit
      | FamilyMemberHistory
      | Flag
      | Goal
      | GraphDefinition
      | Group
      | GuidanceResponse
      | HealthcareService
      | ImagingStudy
      | Immunization
      | ImmunizationEvaluation
      | ImmunizationRecommendation
      | ImplementationGuide
      | InsurancePlan
      | Invoice
      | Library
      | Linkage
      | List
      | Location
      | Measure
      | MeasureReport
      | Media
      | Medication
      | MedicationAdministration
      | MedicationDispense
      | MedicationKnowledge
      | MedicationRequest
      | MedicationStatement
      | MedicinalProduct
      | MedicinalProductAuthorization
      | MedicinalProductContraindication
      | MedicinalProductIndication
      | MedicinalProductIngredient
      | MedicinalProductInteraction
      | MedicinalProductManufactured
      | MedicinalProductPackaged
      | MedicinalProductPharmaceutical
      | MedicinalProductUndesirableEffect
      | MessageDefinition
      | MessageHeader
      | MolecularSequence
      | NamingSystem
      | NutritionOrder
      | Observation
      | ObservationDefinition
      | Organization
      | OrganizationAffiliation
      | Patient
      | PaymentNotice
      | PaymentReconciliation
      | Person
      | PlanDefinition
      | Practitioner
      | PractitionerRole
      | Procedure
      | Provenance
      | Questionnaire
      | QuestionnaireResponse
      | RelatedPerson
      | RequestGroup
      | ResearchDefinition
      | ResearchElementDefinition
      | ResearchStudy
      | ResearchSubject
      | RiskAssessment
      | RiskEvidenceSynthesis
      | Schedule
      | ServiceRequest
      | Slot
      | Specimen
      | SpecimenDefinition
      | StructureDefinition
      | StructureMap
      | Subscription
      | Substance
      | SubstanceNucleicAcid
      | SubstancePolymer
      | SubstanceProtein
      | SubstanceReferenceInformation
      | SubstanceSourceMaterial
      | SubstanceSpecification
      | SupplyDelivery
      | SupplyRequest
      | Task
      | TerminologyCapabilities
      | TestReport
      | TestScript
      | ValueSet
      | VerificationResult
      | VisionPrescription
      | AccessPolicyV2
      | ClientApplication
      | IdentityProvider
      | Membership
      | Project
      | User
      | SearchParameter
      | Account
      | ActivityDefinition
      | AdverseEvent
      | AllergyIntolerance
      | Appointment
      | AppointmentResponse
      | AuditEvent
      | Basic
      | Binary
      | BiologicallyDerivedProduct
      | BodyStructure
      | Bundle
      | CapabilityStatement
      | CarePlan
      | CareTeam
      | CatalogEntry
      | ChargeItem
      | ChargeItemDefinition
      | Claim
      | ClaimResponse
      | ClinicalImpression
      | CodeSystem
      | Communication
      | CommunicationRequest
      | CompartmentDefinition
      | Composition
      | ConceptMap
      | Condition
      | Consent
      | Contract
      | Coverage
      | CoverageEligibilityRequest
      | CoverageEligibilityResponse
      | DetectedIssue
      | Device
      | DeviceDefinition
      | DeviceMetric
      | DeviceRequest
      | DeviceUseStatement
      | DiagnosticReport
      | DocumentManifest
      | DocumentReference
      | Encounter
      | Endpoint
      | EnrollmentRequest
      | EnrollmentResponse
      | EpisodeOfCare
      | EventDefinition
      | Evidence
      | EvidenceVariable
      | ExampleScenario
      | ExplanationOfBenefit
      | FamilyMemberHistory
      | Flag
      | Goal
      | GraphDefinition
      | Group
      | GuidanceResponse
      | HealthcareService
      | ImagingStudy
      | Immunization
      | ImmunizationEvaluation
      | ImmunizationRecommendation
      | ImplementationGuide
      | InsurancePlan
      | Invoice
      | Library
      | Linkage
      | List
      | Location
      | Measure
      | MeasureReport
      | Media
      | Medication
      | MedicationAdministration
      | MedicationDispense
      | MedicationKnowledge
      | MedicationRequest
      | MedicationStatement
      | MessageDefinition
      | MessageHeader
      | MolecularSequence
      | NamingSystem
      | NutritionOrder
      | Observation
      | ObservationDefinition
      | OperationDefinition
      | OperationOutcome
      | Organization
      | OrganizationAffiliation
      | Parameters
      | Patient
      | PaymentNotice
      | PaymentReconciliation
      | Person
      | PlanDefinition
      | Practitioner
      | PractitionerRole
      | Procedure
      | Provenance
      | Questionnaire
      | QuestionnaireResponse
      | RelatedPerson
      | RequestGroup
      | ResearchDefinition
      | ResearchElementDefinition
      | ResearchStudy
      | ResearchSubject
      | RiskAssessment
      | Schedule
      | ServiceRequest
      | Slot
      | Specimen
      | SpecimenDefinition
      | StructureDefinition
      | StructureMap
      | Subscription
      | Substance
      | SupplyDelivery
      | SupplyRequest
      | Task
      | TerminologyCapabilities
      | TestReport
      | TestScript
      | ValueSet
      | VerificationResult
      | VisionPrescription
      | AdministrableProductDefinition
      | Citation
      | ClinicalUseDefinition
      | EvidenceReport
      | Ingredient
      | ManufacturedItemDefinition
      | MedicinalProductDefinition
      | NutritionProduct
      | PackagedProductDefinition
      | RegulatedAuthorization
      | SubscriptionStatus
      | SubscriptionTopic
      | SubstanceDefinition
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- resource: T
Returns Promise<T>
Implementation of FHIRClientAsync.create
- Defined in packages/client/src/index.ts:123

delete_instance

delete_instance<
    FHIRVersion extends "4.0"
    | "4.3",
    T extends

            | "SearchParameter"
            | "Account"
            | "ActivityDefinition"
            | "AdverseEvent"
            | "AllergyIntolerance"
            | "Appointment"
            | "AppointmentResponse"
            | "AuditEvent"
            | "Basic"
            | "Binary"
            | "BiologicallyDerivedProduct"
            | "BodyStructure"
            | "Bundle"
            | "CapabilityStatement"
            | "CarePlan"
            | "CareTeam"
            | "CatalogEntry"
            | "ChargeItem"
            | "ChargeItemDefinition"
            | "Claim"
            | "ClaimResponse"
            | "ClinicalImpression"
            | "CodeSystem"
            | "Communication"
            | "CommunicationRequest"
            | "CompartmentDefinition"
            | "Composition"
            | "ConceptMap"
            | "Condition"
            | "Consent"
            | "Contract"
            | "Coverage"
            | "CoverageEligibilityRequest"
            | "CoverageEligibilityResponse"
            | "DetectedIssue"
            | "Device"
            | "DeviceDefinition"
            | "DeviceMetric"
            | "DeviceRequest"
            | "DeviceUseStatement"
            | "DiagnosticReport"
            | "DocumentManifest"
            | "DocumentReference"
            | "EffectEvidenceSynthesis"
            | "Encounter"
            | "Endpoint"
            | "EnrollmentRequest"
            | "EnrollmentResponse"
            | "EpisodeOfCare"
            | "EventDefinition"
            | "Evidence"
            | "EvidenceVariable"
            | "ExampleScenario"
            | "ExplanationOfBenefit"
            | "FamilyMemberHistory"
            | "Flag"
            | "Goal"
            | "GraphDefinition"
            | "Group"
            | "GuidanceResponse"
            | "HealthcareService"
            | "ImagingStudy"
            | "Immunization"
            | "ImmunizationEvaluation"
            | "ImmunizationRecommendation"
            | "ImplementationGuide"
            | "InsurancePlan"
            | "Invoice"
            | "Library"
            | "Linkage"
            | "List"
            | "Location"
            | "Measure"
            | "MeasureReport"
            | "Media"
            | "Medication"
            | "MedicationAdministration"
            | "MedicationDispense"
            | "MedicationKnowledge"
            | "MedicationRequest"
            | "MedicationStatement"
            | "MedicinalProduct"
            | "MedicinalProductAuthorization"
            | "MedicinalProductContraindication"
            | "MedicinalProductIndication"
            | "MedicinalProductIngredient"
            | "MedicinalProductInteraction"
            | "MedicinalProductManufactured"
            | "MedicinalProductPackaged"
            | "MedicinalProductPharmaceutical"
            | "MedicinalProductUndesirableEffect"
            | "MessageDefinition"
            | "MessageHeader"
            | "MolecularSequence"
            | "NamingSystem"
            | "NutritionOrder"
            | "Observation"
            | "ObservationDefinition"
            | "OperationDefinition"
            | "OperationOutcome"
            | "Organization"
            | "OrganizationAffiliation"
            | "Parameters"
            | "Patient"
            | "PaymentNotice"
            | "PaymentReconciliation"
            | "Person"
            | "PlanDefinition"
            | "Practitioner"
            | "PractitionerRole"
            | "Procedure"
            | "Provenance"
            | "Questionnaire"
            | "QuestionnaireResponse"
            | "RelatedPerson"
            | "RequestGroup"
            | "ResearchDefinition"
            | "ResearchElementDefinition"
            | "ResearchStudy"
            | "ResearchSubject"
            | "RiskAssessment"
            | "RiskEvidenceSynthesis"
            | "Schedule"
            | "ServiceRequest"
            | "Slot"
            | "Specimen"
            | "SpecimenDefinition"
            | "StructureDefinition"
            | "StructureMap"
            | "Subscription"
            | "Substance"
            | "SubstanceNucleicAcid"
            | "SubstancePolymer"
            | "SubstanceProtein"
            | "SubstanceReferenceInformation"
            | "SubstanceSourceMaterial"
            | "SubstanceSpecification"
            | "SupplyDelivery"
            | "SupplyRequest"
            | "Task"
            | "TerminologyCapabilities"
            | "TestReport"
            | "TestScript"
            | "ValueSet"
            | "VerificationResult"
            | "VisionPrescription"
            | "AccessPolicyV2"
            | "ClientApplication"
            | "IdentityProvider"
            | "Membership"
            | "Project"
            | "User"
            | "AdministrableProductDefinition"
            | "Citation"
            | "ClinicalUseDefinition"
            | "EvidenceReport"
            | "Ingredient"
            | "ManufacturedItemDefinition"
            | "MedicinalProductDefinition"
            | "NutritionProduct"
            | "PackagedProductDefinition"
            | "RegulatedAuthorization"
            | "SubscriptionStatus"
            | "SubscriptionTopic"
            | "SubstanceDefinition",
>(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    resourceType: T,
    id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>,
): Promise<void>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
- T extends
      | "SearchParameter"
      | "Account"
      | "ActivityDefinition"
      | "AdverseEvent"
      | "AllergyIntolerance"
      | "Appointment"
      | "AppointmentResponse"
      | "AuditEvent"
      | "Basic"
      | "Binary"
      | "BiologicallyDerivedProduct"
      | "BodyStructure"
      | "Bundle"
      | "CapabilityStatement"
      | "CarePlan"
      | "CareTeam"
      | "CatalogEntry"
      | "ChargeItem"
      | "ChargeItemDefinition"
      | "Claim"
      | "ClaimResponse"
      | "ClinicalImpression"
      | "CodeSystem"
      | "Communication"
      | "CommunicationRequest"
      | "CompartmentDefinition"
      | "Composition"
      | "ConceptMap"
      | "Condition"
      | "Consent"
      | "Contract"
      | "Coverage"
      | "CoverageEligibilityRequest"
      | "CoverageEligibilityResponse"
      | "DetectedIssue"
      | "Device"
      | "DeviceDefinition"
      | "DeviceMetric"
      | "DeviceRequest"
      | "DeviceUseStatement"
      | "DiagnosticReport"
      | "DocumentManifest"
      | "DocumentReference"
      | "EffectEvidenceSynthesis"
      | "Encounter"
      | "Endpoint"
      | "EnrollmentRequest"
      | "EnrollmentResponse"
      | "EpisodeOfCare"
      | "EventDefinition"
      | "Evidence"
      | "EvidenceVariable"
      | "ExampleScenario"
      | "ExplanationOfBenefit"
      | "FamilyMemberHistory"
      | "Flag"
      | "Goal"
      | "GraphDefinition"
      | "Group"
      | "GuidanceResponse"
      | "HealthcareService"
      | "ImagingStudy"
      | "Immunization"
      | "ImmunizationEvaluation"
      | "ImmunizationRecommendation"
      | "ImplementationGuide"
      | "InsurancePlan"
      | "Invoice"
      | "Library"
      | "Linkage"
      | "List"
      | "Location"
      | "Measure"
      | "MeasureReport"
      | "Media"
      | "Medication"
      | "MedicationAdministration"
      | "MedicationDispense"
      | "MedicationKnowledge"
      | "MedicationRequest"
      | "MedicationStatement"
      | "MedicinalProduct"
      | "MedicinalProductAuthorization"
      | "MedicinalProductContraindication"
      | "MedicinalProductIndication"
      | "MedicinalProductIngredient"
      | "MedicinalProductInteraction"
      | "MedicinalProductManufactured"
      | "MedicinalProductPackaged"
      | "MedicinalProductPharmaceutical"
      | "MedicinalProductUndesirableEffect"
      | "MessageDefinition"
      | "MessageHeader"
      | "MolecularSequence"
      | "NamingSystem"
      | "NutritionOrder"
      | "Observation"
      | "ObservationDefinition"
      | "OperationDefinition"
      | "OperationOutcome"
      | "Organization"
      | "OrganizationAffiliation"
      | "Parameters"
      | "Patient"
      | "PaymentNotice"
      | "PaymentReconciliation"
      | "Person"
      | "PlanDefinition"
      | "Practitioner"
      | "PractitionerRole"
      | "Procedure"
      | "Provenance"
      | "Questionnaire"
      | "QuestionnaireResponse"
      | "RelatedPerson"
      | "RequestGroup"
      | "ResearchDefinition"
      | "ResearchElementDefinition"
      | "ResearchStudy"
      | "ResearchSubject"
      | "RiskAssessment"
      | "RiskEvidenceSynthesis"
      | "Schedule"
      | "ServiceRequest"
      | "Slot"
      | "Specimen"
      | "SpecimenDefinition"
      | "StructureDefinition"
      | "StructureMap"
      | "Subscription"
      | "Substance"
      | "SubstanceNucleicAcid"
      | "SubstancePolymer"
      | "SubstanceProtein"
      | "SubstanceReferenceInformation"
      | "SubstanceSourceMaterial"
      | "SubstanceSpecification"
      | "SupplyDelivery"
      | "SupplyRequest"
      | "Task"
      | "TerminologyCapabilities"
      | "TestReport"
      | "TestScript"
      | "ValueSet"
      | "VerificationResult"
      | "VisionPrescription"
      | "AccessPolicyV2"
      | "ClientApplication"
      | "IdentityProvider"
      | "Membership"
      | "Project"
      | "User"
      | "AdministrableProductDefinition"
      | "Citation"
      | "ClinicalUseDefinition"
      | "EvidenceReport"
      | "Ingredient"
      | "ManufacturedItemDefinition"
      | "MedicinalProductDefinition"
      | "NutritionProduct"
      | "PackagedProductDefinition"
      | "RegulatedAuthorization"
      | "SubscriptionStatus"
      | "SubscriptionTopic"
      | "SubstanceDefinition"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- resourceType: T
- id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>
Returns Promise<void>
Implementation of FHIRClientAsync.delete_instance
- Defined in packages/client/src/index.ts:256

delete_system

delete_system<FHIRVersion extends "4.0" | "4.3">(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    parameters?: string | ParsedParameter<string | number>[],
): Promise<void>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- Optionalparameters: string | ParsedParameter<string | number>[]
Returns Promise<void>
Implementation of FHIRClientAsync.delete_system
- Defined in packages/client/src/index.ts:300

delete_type

delete_type<
    FHIRVersion extends "4.0"
    | "4.3",
    T extends

            | "SearchParameter"
            | "Account"
            | "ActivityDefinition"
            | "AdverseEvent"
            | "AllergyIntolerance"
            | "Appointment"
            | "AppointmentResponse"
            | "AuditEvent"
            | "Basic"
            | "Binary"
            | "BiologicallyDerivedProduct"
            | "BodyStructure"
            | "Bundle"
            | "CapabilityStatement"
            | "CarePlan"
            | "CareTeam"
            | "CatalogEntry"
            | "ChargeItem"
            | "ChargeItemDefinition"
            | "Claim"
            | "ClaimResponse"
            | "ClinicalImpression"
            | "CodeSystem"
            | "Communication"
            | "CommunicationRequest"
            | "CompartmentDefinition"
            | "Composition"
            | "ConceptMap"
            | "Condition"
            | "Consent"
            | "Contract"
            | "Coverage"
            | "CoverageEligibilityRequest"
            | "CoverageEligibilityResponse"
            | "DetectedIssue"
            | "Device"
            | "DeviceDefinition"
            | "DeviceMetric"
            | "DeviceRequest"
            | "DeviceUseStatement"
            | "DiagnosticReport"
            | "DocumentManifest"
            | "DocumentReference"
            | "EffectEvidenceSynthesis"
            | "Encounter"
            | "Endpoint"
            | "EnrollmentRequest"
            | "EnrollmentResponse"
            | "EpisodeOfCare"
            | "EventDefinition"
            | "Evidence"
            | "EvidenceVariable"
            | "ExampleScenario"
            | "ExplanationOfBenefit"
            | "FamilyMemberHistory"
            | "Flag"
            | "Goal"
            | "GraphDefinition"
            | "Group"
            | "GuidanceResponse"
            | "HealthcareService"
            | "ImagingStudy"
            | "Immunization"
            | "ImmunizationEvaluation"
            | "ImmunizationRecommendation"
            | "ImplementationGuide"
            | "InsurancePlan"
            | "Invoice"
            | "Library"
            | "Linkage"
            | "List"
            | "Location"
            | "Measure"
            | "MeasureReport"
            | "Media"
            | "Medication"
            | "MedicationAdministration"
            | "MedicationDispense"
            | "MedicationKnowledge"
            | "MedicationRequest"
            | "MedicationStatement"
            | "MedicinalProduct"
            | "MedicinalProductAuthorization"
            | "MedicinalProductContraindication"
            | "MedicinalProductIndication"
            | "MedicinalProductIngredient"
            | "MedicinalProductInteraction"
            | "MedicinalProductManufactured"
            | "MedicinalProductPackaged"
            | "MedicinalProductPharmaceutical"
            | "MedicinalProductUndesirableEffect"
            | "MessageDefinition"
            | "MessageHeader"
            | "MolecularSequence"
            | "NamingSystem"
            | "NutritionOrder"
            | "Observation"
            | "ObservationDefinition"
            | "OperationDefinition"
            | "OperationOutcome"
            | "Organization"
            | "OrganizationAffiliation"
            | "Parameters"
            | "Patient"
            | "PaymentNotice"
            | "PaymentReconciliation"
            | "Person"
            | "PlanDefinition"
            | "Practitioner"
            | "PractitionerRole"
            | "Procedure"
            | "Provenance"
            | "Questionnaire"
            | "QuestionnaireResponse"
            | "RelatedPerson"
            | "RequestGroup"
            | "ResearchDefinition"
            | "ResearchElementDefinition"
            | "ResearchStudy"
            | "ResearchSubject"
            | "RiskAssessment"
            | "RiskEvidenceSynthesis"
            | "Schedule"
            | "ServiceRequest"
            | "Slot"
            | "Specimen"
            | "SpecimenDefinition"
            | "StructureDefinition"
            | "StructureMap"
            | "Subscription"
            | "Substance"
            | "SubstanceNucleicAcid"
            | "SubstancePolymer"
            | "SubstanceProtein"
            | "SubstanceReferenceInformation"
            | "SubstanceSourceMaterial"
            | "SubstanceSpecification"
            | "SupplyDelivery"
            | "SupplyRequest"
            | "Task"
            | "TerminologyCapabilities"
            | "TestReport"
            | "TestScript"
            | "ValueSet"
            | "VerificationResult"
            | "VisionPrescription"
            | "AccessPolicyV2"
            | "ClientApplication"
            | "IdentityProvider"
            | "Membership"
            | "Project"
            | "User"
            | "AdministrableProductDefinition"
            | "Citation"
            | "ClinicalUseDefinition"
            | "EvidenceReport"
            | "Ingredient"
            | "ManufacturedItemDefinition"
            | "MedicinalProductDefinition"
            | "NutritionProduct"
            | "PackagedProductDefinition"
            | "RegulatedAuthorization"
            | "SubscriptionStatus"
            | "SubscriptionTopic"
            | "SubstanceDefinition",
>(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    resourceType: T,
    parameters?: string | ParsedParameter<string | number>[],
): Promise<void>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
- T extends
      | "SearchParameter"
      | "Account"
      | "ActivityDefinition"
      | "AdverseEvent"
      | "AllergyIntolerance"
      | "Appointment"
      | "AppointmentResponse"
      | "AuditEvent"
      | "Basic"
      | "Binary"
      | "BiologicallyDerivedProduct"
      | "BodyStructure"
      | "Bundle"
      | "CapabilityStatement"
      | "CarePlan"
      | "CareTeam"
      | "CatalogEntry"
      | "ChargeItem"
      | "ChargeItemDefinition"
      | "Claim"
      | "ClaimResponse"
      | "ClinicalImpression"
      | "CodeSystem"
      | "Communication"
      | "CommunicationRequest"
      | "CompartmentDefinition"
      | "Composition"
      | "ConceptMap"
      | "Condition"
      | "Consent"
      | "Contract"
      | "Coverage"
      | "CoverageEligibilityRequest"
      | "CoverageEligibilityResponse"
      | "DetectedIssue"
      | "Device"
      | "DeviceDefinition"
      | "DeviceMetric"
      | "DeviceRequest"
      | "DeviceUseStatement"
      | "DiagnosticReport"
      | "DocumentManifest"
      | "DocumentReference"
      | "EffectEvidenceSynthesis"
      | "Encounter"
      | "Endpoint"
      | "EnrollmentRequest"
      | "EnrollmentResponse"
      | "EpisodeOfCare"
      | "EventDefinition"
      | "Evidence"
      | "EvidenceVariable"
      | "ExampleScenario"
      | "ExplanationOfBenefit"
      | "FamilyMemberHistory"
      | "Flag"
      | "Goal"
      | "GraphDefinition"
      | "Group"
      | "GuidanceResponse"
      | "HealthcareService"
      | "ImagingStudy"
      | "Immunization"
      | "ImmunizationEvaluation"
      | "ImmunizationRecommendation"
      | "ImplementationGuide"
      | "InsurancePlan"
      | "Invoice"
      | "Library"
      | "Linkage"
      | "List"
      | "Location"
      | "Measure"
      | "MeasureReport"
      | "Media"
      | "Medication"
      | "MedicationAdministration"
      | "MedicationDispense"
      | "MedicationKnowledge"
      | "MedicationRequest"
      | "MedicationStatement"
      | "MedicinalProduct"
      | "MedicinalProductAuthorization"
      | "MedicinalProductContraindication"
      | "MedicinalProductIndication"
      | "MedicinalProductIngredient"
      | "MedicinalProductInteraction"
      | "MedicinalProductManufactured"
      | "MedicinalProductPackaged"
      | "MedicinalProductPharmaceutical"
      | "MedicinalProductUndesirableEffect"
      | "MessageDefinition"
      | "MessageHeader"
      | "MolecularSequence"
      | "NamingSystem"
      | "NutritionOrder"
      | "Observation"
      | "ObservationDefinition"
      | "OperationDefinition"
      | "OperationOutcome"
      | "Organization"
      | "OrganizationAffiliation"
      | "Parameters"
      | "Patient"
      | "PaymentNotice"
      | "PaymentReconciliation"
      | "Person"
      | "PlanDefinition"
      | "Practitioner"
      | "PractitionerRole"
      | "Procedure"
      | "Provenance"
      | "Questionnaire"
      | "QuestionnaireResponse"
      | "RelatedPerson"
      | "RequestGroup"
      | "ResearchDefinition"
      | "ResearchElementDefinition"
      | "ResearchStudy"
      | "ResearchSubject"
      | "RiskAssessment"
      | "RiskEvidenceSynthesis"
      | "Schedule"
      | "ServiceRequest"
      | "Slot"
      | "Specimen"
      | "SpecimenDefinition"
      | "StructureDefinition"
      | "StructureMap"
      | "Subscription"
      | "Substance"
      | "SubstanceNucleicAcid"
      | "SubstancePolymer"
      | "SubstanceProtein"
      | "SubstanceReferenceInformation"
      | "SubstanceSourceMaterial"
      | "SubstanceSpecification"
      | "SupplyDelivery"
      | "SupplyRequest"
      | "Task"
      | "TerminologyCapabilities"
      | "TestReport"
      | "TestScript"
      | "ValueSet"
      | "VerificationResult"
      | "VisionPrescription"
      | "AccessPolicyV2"
      | "ClientApplication"
      | "IdentityProvider"
      | "Membership"
      | "Project"
      | "User"
      | "AdministrableProductDefinition"
      | "Citation"
      | "ClinicalUseDefinition"
      | "EvidenceReport"
      | "Ingredient"
      | "ManufacturedItemDefinition"
      | "MedicinalProductDefinition"
      | "NutritionProduct"
      | "PackagedProductDefinition"
      | "RegulatedAuthorization"
      | "SubscriptionStatus"
      | "SubscriptionTopic"
      | "SubstanceDefinition"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- resourceType: T
- Optionalparameters: string | ParsedParameter<string | number>[]
Returns Promise<void>
Implementation of FHIRClientAsync.delete_type
- Defined in packages/client/src/index.ts:275

history_instance

history_instance<
    FHIRVersion extends "4.0"
    | "4.3",
    T extends

            | "SearchParameter"
            | "Account"
            | "ActivityDefinition"
            | "AdverseEvent"
            | "AllergyIntolerance"
            | "Appointment"
            | "AppointmentResponse"
            | "AuditEvent"
            | "Basic"
            | "Binary"
            | "BiologicallyDerivedProduct"
            | "BodyStructure"
            | "Bundle"
            | "CapabilityStatement"
            | "CarePlan"
            | "CareTeam"
            | "CatalogEntry"
            | "ChargeItem"
            | "ChargeItemDefinition"
            | "Claim"
            | "ClaimResponse"
            | "ClinicalImpression"
            | "CodeSystem"
            | "Communication"
            | "CommunicationRequest"
            | "CompartmentDefinition"
            | "Composition"
            | "ConceptMap"
            | "Condition"
            | "Consent"
            | "Contract"
            | "Coverage"
            | "CoverageEligibilityRequest"
            | "CoverageEligibilityResponse"
            | "DetectedIssue"
            | "Device"
            | "DeviceDefinition"
            | "DeviceMetric"
            | "DeviceRequest"
            | "DeviceUseStatement"
            | "DiagnosticReport"
            | "DocumentManifest"
            | "DocumentReference"
            | "EffectEvidenceSynthesis"
            | "Encounter"
            | "Endpoint"
            | "EnrollmentRequest"
            | "EnrollmentResponse"
            | "EpisodeOfCare"
            | "EventDefinition"
            | "Evidence"
            | "EvidenceVariable"
            | "ExampleScenario"
            | "ExplanationOfBenefit"
            | "FamilyMemberHistory"
            | "Flag"
            | "Goal"
            | "GraphDefinition"
            | "Group"
            | "GuidanceResponse"
            | "HealthcareService"
            | "ImagingStudy"
            | "Immunization"
            | "ImmunizationEvaluation"
            | "ImmunizationRecommendation"
            | "ImplementationGuide"
            | "InsurancePlan"
            | "Invoice"
            | "Library"
            | "Linkage"
            | "List"
            | "Location"
            | "Measure"
            | "MeasureReport"
            | "Media"
            | "Medication"
            | "MedicationAdministration"
            | "MedicationDispense"
            | "MedicationKnowledge"
            | "MedicationRequest"
            | "MedicationStatement"
            | "MedicinalProduct"
            | "MedicinalProductAuthorization"
            | "MedicinalProductContraindication"
            | "MedicinalProductIndication"
            | "MedicinalProductIngredient"
            | "MedicinalProductInteraction"
            | "MedicinalProductManufactured"
            | "MedicinalProductPackaged"
            | "MedicinalProductPharmaceutical"
            | "MedicinalProductUndesirableEffect"
            | "MessageDefinition"
            | "MessageHeader"
            | "MolecularSequence"
            | "NamingSystem"
            | "NutritionOrder"
            | "Observation"
            | "ObservationDefinition"
            | "OperationDefinition"
            | "OperationOutcome"
            | "Organization"
            | "OrganizationAffiliation"
            | "Parameters"
            | "Patient"
            | "PaymentNotice"
            | "PaymentReconciliation"
            | "Person"
            | "PlanDefinition"
            | "Practitioner"
            | "PractitionerRole"
            | "Procedure"
            | "Provenance"
            | "Questionnaire"
            | "QuestionnaireResponse"
            | "RelatedPerson"
            | "RequestGroup"
            | "ResearchDefinition"
            | "ResearchElementDefinition"
            | "ResearchStudy"
            | "ResearchSubject"
            | "RiskAssessment"
            | "RiskEvidenceSynthesis"
            | "Schedule"
            | "ServiceRequest"
            | "Slot"
            | "Specimen"
            | "SpecimenDefinition"
            | "StructureDefinition"
            | "StructureMap"
            | "Subscription"
            | "Substance"
            | "SubstanceNucleicAcid"
            | "SubstancePolymer"
            | "SubstanceProtein"
            | "SubstanceReferenceInformation"
            | "SubstanceSourceMaterial"
            | "SubstanceSpecification"
            | "SupplyDelivery"
            | "SupplyRequest"
            | "Task"
            | "TerminologyCapabilities"
            | "TestReport"
            | "TestScript"
            | "ValueSet"
            | "VerificationResult"
            | "VisionPrescription"
            | "AccessPolicyV2"
            | "ClientApplication"
            | "IdentityProvider"
            | "Membership"
            | "Project"
            | "User"
            | "AdministrableProductDefinition"
            | "Citation"
            | "ClinicalUseDefinition"
            | "EvidenceReport"
            | "Ingredient"
            | "ManufacturedItemDefinition"
            | "MedicinalProductDefinition"
            | "NutritionProduct"
            | "PackagedProductDefinition"
            | "RegulatedAuthorization"
            | "SubscriptionStatus"
            | "SubscriptionTopic"
            | "SubstanceDefinition",
>(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    resourceType: T,
    id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>,
    parameters?: string | ParsedParameter<string | number>[],
): Promise<NonNullable<Resource<FHIRVersion, "Bundle">["entry"]>>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
- T extends
      | "SearchParameter"
      | "Account"
      | "ActivityDefinition"
      | "AdverseEvent"
      | "AllergyIntolerance"
      | "Appointment"
      | "AppointmentResponse"
      | "AuditEvent"
      | "Basic"
      | "Binary"
      | "BiologicallyDerivedProduct"
      | "BodyStructure"
      | "Bundle"
      | "CapabilityStatement"
      | "CarePlan"
      | "CareTeam"
      | "CatalogEntry"
      | "ChargeItem"
      | "ChargeItemDefinition"
      | "Claim"
      | "ClaimResponse"
      | "ClinicalImpression"
      | "CodeSystem"
      | "Communication"
      | "CommunicationRequest"
      | "CompartmentDefinition"
      | "Composition"
      | "ConceptMap"
      | "Condition"
      | "Consent"
      | "Contract"
      | "Coverage"
      | "CoverageEligibilityRequest"
      | "CoverageEligibilityResponse"
      | "DetectedIssue"
      | "Device"
      | "DeviceDefinition"
      | "DeviceMetric"
      | "DeviceRequest"
      | "DeviceUseStatement"
      | "DiagnosticReport"
      | "DocumentManifest"
      | "DocumentReference"
      | "EffectEvidenceSynthesis"
      | "Encounter"
      | "Endpoint"
      | "EnrollmentRequest"
      | "EnrollmentResponse"
      | "EpisodeOfCare"
      | "EventDefinition"
      | "Evidence"
      | "EvidenceVariable"
      | "ExampleScenario"
      | "ExplanationOfBenefit"
      | "FamilyMemberHistory"
      | "Flag"
      | "Goal"
      | "GraphDefinition"
      | "Group"
      | "GuidanceResponse"
      | "HealthcareService"
      | "ImagingStudy"
      | "Immunization"
      | "ImmunizationEvaluation"
      | "ImmunizationRecommendation"
      | "ImplementationGuide"
      | "InsurancePlan"
      | "Invoice"
      | "Library"
      | "Linkage"
      | "List"
      | "Location"
      | "Measure"
      | "MeasureReport"
      | "Media"
      | "Medication"
      | "MedicationAdministration"
      | "MedicationDispense"
      | "MedicationKnowledge"
      | "MedicationRequest"
      | "MedicationStatement"
      | "MedicinalProduct"
      | "MedicinalProductAuthorization"
      | "MedicinalProductContraindication"
      | "MedicinalProductIndication"
      | "MedicinalProductIngredient"
      | "MedicinalProductInteraction"
      | "MedicinalProductManufactured"
      | "MedicinalProductPackaged"
      | "MedicinalProductPharmaceutical"
      | "MedicinalProductUndesirableEffect"
      | "MessageDefinition"
      | "MessageHeader"
      | "MolecularSequence"
      | "NamingSystem"
      | "NutritionOrder"
      | "Observation"
      | "ObservationDefinition"
      | "OperationDefinition"
      | "OperationOutcome"
      | "Organization"
      | "OrganizationAffiliation"
      | "Parameters"
      | "Patient"
      | "PaymentNotice"
      | "PaymentReconciliation"
      | "Person"
      | "PlanDefinition"
      | "Practitioner"
      | "PractitionerRole"
      | "Procedure"
      | "Provenance"
      | "Questionnaire"
      | "QuestionnaireResponse"
      | "RelatedPerson"
      | "RequestGroup"
      | "ResearchDefinition"
      | "ResearchElementDefinition"
      | "ResearchStudy"
      | "ResearchSubject"
      | "RiskAssessment"
      | "RiskEvidenceSynthesis"
      | "Schedule"
      | "ServiceRequest"
      | "Slot"
      | "Specimen"
      | "SpecimenDefinition"
      | "StructureDefinition"
      | "StructureMap"
      | "Subscription"
      | "Substance"
      | "SubstanceNucleicAcid"
      | "SubstancePolymer"
      | "SubstanceProtein"
      | "SubstanceReferenceInformation"
      | "SubstanceSourceMaterial"
      | "SubstanceSpecification"
      | "SupplyDelivery"
      | "SupplyRequest"
      | "Task"
      | "TerminologyCapabilities"
      | "TestReport"
      | "TestScript"
      | "ValueSet"
      | "VerificationResult"
      | "VisionPrescription"
      | "AccessPolicyV2"
      | "ClientApplication"
      | "IdentityProvider"
      | "Membership"
      | "Project"
      | "User"
      | "AdministrableProductDefinition"
      | "Citation"
      | "ClinicalUseDefinition"
      | "EvidenceReport"
      | "Ingredient"
      | "ManufacturedItemDefinition"
      | "MedicinalProductDefinition"
      | "NutritionProduct"
      | "PackagedProductDefinition"
      | "RegulatedAuthorization"
      | "SubscriptionStatus"
      | "SubscriptionTopic"
      | "SubstanceDefinition"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- resourceType: T
- id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>
- Optionalparameters: string | ParsedParameter<string | number>[]
Returns Promise<NonNullable<Resource<FHIRVersion, "Bundle">["entry"]>>
Implementation of FHIRClientAsync.history_instance
- Defined in packages/client/src/index.ts:368

history_system

history_system<FHIRVersion extends "4.0" | "4.3">(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    parameters?: string | ParsedParameter<string | number>[],
): Promise<NonNullable<Resource<FHIRVersion, "Bundle">["entry"]>>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- Optionalparameters: string | ParsedParameter<string | number>[]
Returns Promise<NonNullable<Resource<FHIRVersion, "Bundle">["entry"]>>
Implementation of FHIRClientAsync.history_system
- Defined in packages/client/src/index.ts:320

history_type

history_type<
    FHIRVersion extends "4.0"
    | "4.3",
    T extends

            | "SearchParameter"
            | "Account"
            | "ActivityDefinition"
            | "AdverseEvent"
            | "AllergyIntolerance"
            | "Appointment"
            | "AppointmentResponse"
            | "AuditEvent"
            | "Basic"
            | "Binary"
            | "BiologicallyDerivedProduct"
            | "BodyStructure"
            | "Bundle"
            | "CapabilityStatement"
            | "CarePlan"
            | "CareTeam"
            | "CatalogEntry"
            | "ChargeItem"
            | "ChargeItemDefinition"
            | "Claim"
            | "ClaimResponse"
            | "ClinicalImpression"
            | "CodeSystem"
            | "Communication"
            | "CommunicationRequest"
            | "CompartmentDefinition"
            | "Composition"
            | "ConceptMap"
            | "Condition"
            | "Consent"
            | "Contract"
            | "Coverage"
            | "CoverageEligibilityRequest"
            | "CoverageEligibilityResponse"
            | "DetectedIssue"
            | "Device"
            | "DeviceDefinition"
            | "DeviceMetric"
            | "DeviceRequest"
            | "DeviceUseStatement"
            | "DiagnosticReport"
            | "DocumentManifest"
            | "DocumentReference"
            | "EffectEvidenceSynthesis"
            | "Encounter"
            | "Endpoint"
            | "EnrollmentRequest"
            | "EnrollmentResponse"
            | "EpisodeOfCare"
            | "EventDefinition"
            | "Evidence"
            | "EvidenceVariable"
            | "ExampleScenario"
            | "ExplanationOfBenefit"
            | "FamilyMemberHistory"
            | "Flag"
            | "Goal"
            | "GraphDefinition"
            | "Group"
            | "GuidanceResponse"
            | "HealthcareService"
            | "ImagingStudy"
            | "Immunization"
            | "ImmunizationEvaluation"
            | "ImmunizationRecommendation"
            | "ImplementationGuide"
            | "InsurancePlan"
            | "Invoice"
            | "Library"
            | "Linkage"
            | "List"
            | "Location"
            | "Measure"
            | "MeasureReport"
            | "Media"
            | "Medication"
            | "MedicationAdministration"
            | "MedicationDispense"
            | "MedicationKnowledge"
            | "MedicationRequest"
            | "MedicationStatement"
            | "MedicinalProduct"
            | "MedicinalProductAuthorization"
            | "MedicinalProductContraindication"
            | "MedicinalProductIndication"
            | "MedicinalProductIngredient"
            | "MedicinalProductInteraction"
            | "MedicinalProductManufactured"
            | "MedicinalProductPackaged"
            | "MedicinalProductPharmaceutical"
            | "MedicinalProductUndesirableEffect"
            | "MessageDefinition"
            | "MessageHeader"
            | "MolecularSequence"
            | "NamingSystem"
            | "NutritionOrder"
            | "Observation"
            | "ObservationDefinition"
            | "OperationDefinition"
            | "OperationOutcome"
            | "Organization"
            | "OrganizationAffiliation"
            | "Parameters"
            | "Patient"
            | "PaymentNotice"
            | "PaymentReconciliation"
            | "Person"
            | "PlanDefinition"
            | "Practitioner"
            | "PractitionerRole"
            | "Procedure"
            | "Provenance"
            | "Questionnaire"
            | "QuestionnaireResponse"
            | "RelatedPerson"
            | "RequestGroup"
            | "ResearchDefinition"
            | "ResearchElementDefinition"
            | "ResearchStudy"
            | "ResearchSubject"
            | "RiskAssessment"
            | "RiskEvidenceSynthesis"
            | "Schedule"
            | "ServiceRequest"
            | "Slot"
            | "Specimen"
            | "SpecimenDefinition"
            | "StructureDefinition"
            | "StructureMap"
            | "Subscription"
            | "Substance"
            | "SubstanceNucleicAcid"
            | "SubstancePolymer"
            | "SubstanceProtein"
            | "SubstanceReferenceInformation"
            | "SubstanceSourceMaterial"
            | "SubstanceSpecification"
            | "SupplyDelivery"
            | "SupplyRequest"
            | "Task"
            | "TerminologyCapabilities"
            | "TestReport"
            | "TestScript"
            | "ValueSet"
            | "VerificationResult"
            | "VisionPrescription"
            | "AccessPolicyV2"
            | "ClientApplication"
            | "IdentityProvider"
            | "Membership"
            | "Project"
            | "User"
            | "AdministrableProductDefinition"
            | "Citation"
            | "ClinicalUseDefinition"
            | "EvidenceReport"
            | "Ingredient"
            | "ManufacturedItemDefinition"
            | "MedicinalProductDefinition"
            | "NutritionProduct"
            | "PackagedProductDefinition"
            | "RegulatedAuthorization"
            | "SubscriptionStatus"
            | "SubscriptionTopic"
            | "SubstanceDefinition",
>(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    resourceType: T,
    parameters?: string | ParsedParameter<string | number>[],
): Promise<NonNullable<Resource<FHIRVersion, "Bundle">["entry"]>>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
- T extends
      | "SearchParameter"
      | "Account"
      | "ActivityDefinition"
      | "AdverseEvent"
      | "AllergyIntolerance"
      | "Appointment"
      | "AppointmentResponse"
      | "AuditEvent"
      | "Basic"
      | "Binary"
      | "BiologicallyDerivedProduct"
      | "BodyStructure"
      | "Bundle"
      | "CapabilityStatement"
      | "CarePlan"
      | "CareTeam"
      | "CatalogEntry"
      | "ChargeItem"
      | "ChargeItemDefinition"
      | "Claim"
      | "ClaimResponse"
      | "ClinicalImpression"
      | "CodeSystem"
      | "Communication"
      | "CommunicationRequest"
      | "CompartmentDefinition"
      | "Composition"
      | "ConceptMap"
      | "Condition"
      | "Consent"
      | "Contract"
      | "Coverage"
      | "CoverageEligibilityRequest"
      | "CoverageEligibilityResponse"
      | "DetectedIssue"
      | "Device"
      | "DeviceDefinition"
      | "DeviceMetric"
      | "DeviceRequest"
      | "DeviceUseStatement"
      | "DiagnosticReport"
      | "DocumentManifest"
      | "DocumentReference"
      | "EffectEvidenceSynthesis"
      | "Encounter"
      | "Endpoint"
      | "EnrollmentRequest"
      | "EnrollmentResponse"
      | "EpisodeOfCare"
      | "EventDefinition"
      | "Evidence"
      | "EvidenceVariable"
      | "ExampleScenario"
      | "ExplanationOfBenefit"
      | "FamilyMemberHistory"
      | "Flag"
      | "Goal"
      | "GraphDefinition"
      | "Group"
      | "GuidanceResponse"
      | "HealthcareService"
      | "ImagingStudy"
      | "Immunization"
      | "ImmunizationEvaluation"
      | "ImmunizationRecommendation"
      | "ImplementationGuide"
      | "InsurancePlan"
      | "Invoice"
      | "Library"
      | "Linkage"
      | "List"
      | "Location"
      | "Measure"
      | "MeasureReport"
      | "Media"
      | "Medication"
      | "MedicationAdministration"
      | "MedicationDispense"
      | "MedicationKnowledge"
      | "MedicationRequest"
      | "MedicationStatement"
      | "MedicinalProduct"
      | "MedicinalProductAuthorization"
      | "MedicinalProductContraindication"
      | "MedicinalProductIndication"
      | "MedicinalProductIngredient"
      | "MedicinalProductInteraction"
      | "MedicinalProductManufactured"
      | "MedicinalProductPackaged"
      | "MedicinalProductPharmaceutical"
      | "MedicinalProductUndesirableEffect"
      | "MessageDefinition"
      | "MessageHeader"
      | "MolecularSequence"
      | "NamingSystem"
      | "NutritionOrder"
      | "Observation"
      | "ObservationDefinition"
      | "OperationDefinition"
      | "OperationOutcome"
      | "Organization"
      | "OrganizationAffiliation"
      | "Parameters"
      | "Patient"
      | "PaymentNotice"
      | "PaymentReconciliation"
      | "Person"
      | "PlanDefinition"
      | "Practitioner"
      | "PractitionerRole"
      | "Procedure"
      | "Provenance"
      | "Questionnaire"
      | "QuestionnaireResponse"
      | "RelatedPerson"
      | "RequestGroup"
      | "ResearchDefinition"
      | "ResearchElementDefinition"
      | "ResearchStudy"
      | "ResearchSubject"
      | "RiskAssessment"
      | "RiskEvidenceSynthesis"
      | "Schedule"
      | "ServiceRequest"
      | "Slot"
      | "Specimen"
      | "SpecimenDefinition"
      | "StructureDefinition"
      | "StructureMap"
      | "Subscription"
      | "Substance"
      | "SubstanceNucleicAcid"
      | "SubstancePolymer"
      | "SubstanceProtein"
      | "SubstanceReferenceInformation"
      | "SubstanceSourceMaterial"
      | "SubstanceSpecification"
      | "SupplyDelivery"
      | "SupplyRequest"
      | "Task"
      | "TerminologyCapabilities"
      | "TestReport"
      | "TestScript"
      | "ValueSet"
      | "VerificationResult"
      | "VisionPrescription"
      | "AccessPolicyV2"
      | "ClientApplication"
      | "IdentityProvider"
      | "Membership"
      | "Project"
      | "User"
      | "AdministrableProductDefinition"
      | "Citation"
      | "ClinicalUseDefinition"
      | "EvidenceReport"
      | "Ingredient"
      | "ManufacturedItemDefinition"
      | "MedicinalProductDefinition"
      | "NutritionProduct"
      | "PackagedProductDefinition"
      | "RegulatedAuthorization"
      | "SubscriptionStatus"
      | "SubscriptionTopic"
      | "SubstanceDefinition"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- resourceType: T
- Optionalparameters: string | ParsedParameter<string | number>[]
Returns Promise<NonNullable<Resource<FHIRVersion, "Bundle">["entry"]>>
Implementation of FHIRClientAsync.history_type
- Defined in packages/client/src/index.ts:342

invoke_instance

invoke_instance<
    FHIRVersion extends "4.0"
    | "4.3",
    Op extends code | IOperation<any, any>,
    Input extends any,
    Output extends any,
    T extends

            | "SearchParameter"
            | "Account"
            | "ActivityDefinition"
            | "AdverseEvent"
            | "AllergyIntolerance"
            | "Appointment"
            | "AppointmentResponse"
            | "AuditEvent"
            | "Basic"
            | "Binary"
            | "BiologicallyDerivedProduct"
            | "BodyStructure"
            | "Bundle"
            | "CapabilityStatement"
            | "CarePlan"
            | "CareTeam"
            | "CatalogEntry"
            | "ChargeItem"
            | "ChargeItemDefinition"
            | "Claim"
            | "ClaimResponse"
            | "ClinicalImpression"
            | "CodeSystem"
            | "Communication"
            | "CommunicationRequest"
            | "CompartmentDefinition"
            | "Composition"
            | "ConceptMap"
            | "Condition"
            | "Consent"
            | "Contract"
            | "Coverage"
            | "CoverageEligibilityRequest"
            | "CoverageEligibilityResponse"
            | "DetectedIssue"
            | "Device"
            | "DeviceDefinition"
            | "DeviceMetric"
            | "DeviceRequest"
            | "DeviceUseStatement"
            | "DiagnosticReport"
            | "DocumentManifest"
            | "DocumentReference"
            | "EffectEvidenceSynthesis"
            | "Encounter"
            | "Endpoint"
            | "EnrollmentRequest"
            | "EnrollmentResponse"
            | "EpisodeOfCare"
            | "EventDefinition"
            | "Evidence"
            | "EvidenceVariable"
            | "ExampleScenario"
            | "ExplanationOfBenefit"
            | "FamilyMemberHistory"
            | "Flag"
            | "Goal"
            | "GraphDefinition"
            | "Group"
            | "GuidanceResponse"
            | "HealthcareService"
            | "ImagingStudy"
            | "Immunization"
            | "ImmunizationEvaluation"
            | "ImmunizationRecommendation"
            | "ImplementationGuide"
            | "InsurancePlan"
            | "Invoice"
            | "Library"
            | "Linkage"
            | "List"
            | "Location"
            | "Measure"
            | "MeasureReport"
            | "Media"
            | "Medication"
            | "MedicationAdministration"
            | "MedicationDispense"
            | "MedicationKnowledge"
            | "MedicationRequest"
            | "MedicationStatement"
            | "MedicinalProduct"
            | "MedicinalProductAuthorization"
            | "MedicinalProductContraindication"
            | "MedicinalProductIndication"
            | "MedicinalProductIngredient"
            | "MedicinalProductInteraction"
            | "MedicinalProductManufactured"
            | "MedicinalProductPackaged"
            | "MedicinalProductPharmaceutical"
            | "MedicinalProductUndesirableEffect"
            | "MessageDefinition"
            | "MessageHeader"
            | "MolecularSequence"
            | "NamingSystem"
            | "NutritionOrder"
            | "Observation"
            | "ObservationDefinition"
            | "OperationDefinition"
            | "OperationOutcome"
            | "Organization"
            | "OrganizationAffiliation"
            | "Parameters"
            | "Patient"
            | "PaymentNotice"
            | "PaymentReconciliation"
            | "Person"
            | "PlanDefinition"
            | "Practitioner"
            | "PractitionerRole"
            | "Procedure"
            | "Provenance"
            | "Questionnaire"
            | "QuestionnaireResponse"
            | "RelatedPerson"
            | "RequestGroup"
            | "ResearchDefinition"
            | "ResearchElementDefinition"
            | "ResearchStudy"
            | "ResearchSubject"
            | "RiskAssessment"
            | "RiskEvidenceSynthesis"
            | "Schedule"
            | "ServiceRequest"
            | "Slot"
            | "Specimen"
            | "SpecimenDefinition"
            | "StructureDefinition"
            | "StructureMap"
            | "Subscription"
            | "Substance"
            | "SubstanceNucleicAcid"
            | "SubstancePolymer"
            | "SubstanceProtein"
            | "SubstanceReferenceInformation"
            | "SubstanceSourceMaterial"
            | "SubstanceSpecification"
            | "SupplyDelivery"
            | "SupplyRequest"
            | "Task"
            | "TerminologyCapabilities"
            | "TestReport"
            | "TestScript"
            | "ValueSet"
            | "VerificationResult"
            | "VisionPrescription"
            | "AccessPolicyV2"
            | "ClientApplication"
            | "IdentityProvider"
            | "Membership"
            | "Project"
            | "User"
            | "AdministrableProductDefinition"
            | "Citation"
            | "ClinicalUseDefinition"
            | "EvidenceReport"
            | "Ingredient"
            | "ManufacturedItemDefinition"
            | "MedicinalProductDefinition"
            | "NutritionProduct"
            | "PackagedProductDefinition"
            | "RegulatedAuthorization"
            | "SubscriptionStatus"
            | "SubscriptionTopic"
            | "SubstanceDefinition",
>(
    op: Op,
    ctx: CTX,
    fhirVersion: FHIRVersion,
    resourceType: T,
    id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>,
    input: Input,
): Promise<Output>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
- Op extends code | IOperation<any, any>
- Input extends any
- Output extends any
- T extends
      | "SearchParameter"
      | "Account"
      | "ActivityDefinition"
      | "AdverseEvent"
      | "AllergyIntolerance"
      | "Appointment"
      | "AppointmentResponse"
      | "AuditEvent"
      | "Basic"
      | "Binary"
      | "BiologicallyDerivedProduct"
      | "BodyStructure"
      | "Bundle"
      | "CapabilityStatement"
      | "CarePlan"
      | "CareTeam"
      | "CatalogEntry"
      | "ChargeItem"
      | "ChargeItemDefinition"
      | "Claim"
      | "ClaimResponse"
      | "ClinicalImpression"
      | "CodeSystem"
      | "Communication"
      | "CommunicationRequest"
      | "CompartmentDefinition"
      | "Composition"
      | "ConceptMap"
      | "Condition"
      | "Consent"
      | "Contract"
      | "Coverage"
      | "CoverageEligibilityRequest"
      | "CoverageEligibilityResponse"
      | "DetectedIssue"
      | "Device"
      | "DeviceDefinition"
      | "DeviceMetric"
      | "DeviceRequest"
      | "DeviceUseStatement"
      | "DiagnosticReport"
      | "DocumentManifest"
      | "DocumentReference"
      | "EffectEvidenceSynthesis"
      | "Encounter"
      | "Endpoint"
      | "EnrollmentRequest"
      | "EnrollmentResponse"
      | "EpisodeOfCare"
      | "EventDefinition"
      | "Evidence"
      | "EvidenceVariable"
      | "ExampleScenario"
      | "ExplanationOfBenefit"
      | "FamilyMemberHistory"
      | "Flag"
      | "Goal"
      | "GraphDefinition"
      | "Group"
      | "GuidanceResponse"
      | "HealthcareService"
      | "ImagingStudy"
      | "Immunization"
      | "ImmunizationEvaluation"
      | "ImmunizationRecommendation"
      | "ImplementationGuide"
      | "InsurancePlan"
      | "Invoice"
      | "Library"
      | "Linkage"
      | "List"
      | "Location"
      | "Measure"
      | "MeasureReport"
      | "Media"
      | "Medication"
      | "MedicationAdministration"
      | "MedicationDispense"
      | "MedicationKnowledge"
      | "MedicationRequest"
      | "MedicationStatement"
      | "MedicinalProduct"
      | "MedicinalProductAuthorization"
      | "MedicinalProductContraindication"
      | "MedicinalProductIndication"
      | "MedicinalProductIngredient"
      | "MedicinalProductInteraction"
      | "MedicinalProductManufactured"
      | "MedicinalProductPackaged"
      | "MedicinalProductPharmaceutical"
      | "MedicinalProductUndesirableEffect"
      | "MessageDefinition"
      | "MessageHeader"
      | "MolecularSequence"
      | "NamingSystem"
      | "NutritionOrder"
      | "Observation"
      | "ObservationDefinition"
      | "OperationDefinition"
      | "OperationOutcome"
      | "Organization"
      | "OrganizationAffiliation"
      | "Parameters"
      | "Patient"
      | "PaymentNotice"
      | "PaymentReconciliation"
      | "Person"
      | "PlanDefinition"
      | "Practitioner"
      | "PractitionerRole"
      | "Procedure"
      | "Provenance"
      | "Questionnaire"
      | "QuestionnaireResponse"
      | "RelatedPerson"
      | "RequestGroup"
      | "ResearchDefinition"
      | "ResearchElementDefinition"
      | "ResearchStudy"
      | "ResearchSubject"
      | "RiskAssessment"
      | "RiskEvidenceSynthesis"
      | "Schedule"
      | "ServiceRequest"
      | "Slot"
      | "Specimen"
      | "SpecimenDefinition"
      | "StructureDefinition"
      | "StructureMap"
      | "Subscription"
      | "Substance"
      | "SubstanceNucleicAcid"
      | "SubstancePolymer"
      | "SubstanceProtein"
      | "SubstanceReferenceInformation"
      | "SubstanceSourceMaterial"
      | "SubstanceSpecification"
      | "SupplyDelivery"
      | "SupplyRequest"
      | "Task"
      | "TerminologyCapabilities"
      | "TestReport"
      | "TestScript"
      | "ValueSet"
      | "VerificationResult"
      | "VisionPrescription"
      | "AccessPolicyV2"
      | "ClientApplication"
      | "IdentityProvider"
      | "Membership"
      | "Project"
      | "User"
      | "AdministrableProductDefinition"
      | "Citation"
      | "ClinicalUseDefinition"
      | "EvidenceReport"
      | "Ingredient"
      | "ManufacturedItemDefinition"
      | "MedicinalProductDefinition"
      | "NutritionProduct"
      | "PackagedProductDefinition"
      | "RegulatedAuthorization"
      | "SubscriptionStatus"
      | "SubscriptionTopic"
      | "SubstanceDefinition"
Parameters
- op: Op
- ctx: CTX
- fhirVersion: FHIRVersion
- resourceType: T
- id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>
- input: Input
Returns Promise<Output>
Implementation of FHIRClientAsync.invoke_instance
- Defined in packages/client/src/index.ts:468

invoke_system

invoke_system<
    FHIRVersion extends "4.0"
    | "4.3",
    Op extends code | IOperation<any, any>,
    Input extends any,
    Output extends any,
>(
    op: Op,
    ctx: CTX,
    fhirVersion: FHIRVersion,
    input: Input,
): Promise<Output>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
- Op extends code | IOperation<any, any>
- Input extends any
- Output extends any
Parameters
- op: Op
- ctx: CTX
- fhirVersion: FHIRVersion
- input: Input
Returns Promise<Output>
Implementation of FHIRClientAsync.invoke_system
- Defined in packages/client/src/index.ts:396

invoke_type

invoke_type<
    FHIRVersion extends "4.0"
    | "4.3",
    Op extends code | IOperation<any, any>,
    Input extends any,
    Output extends any,
    T extends

            | "SearchParameter"
            | "Account"
            | "ActivityDefinition"
            | "AdverseEvent"
            | "AllergyIntolerance"
            | "Appointment"
            | "AppointmentResponse"
            | "AuditEvent"
            | "Basic"
            | "Binary"
            | "BiologicallyDerivedProduct"
            | "BodyStructure"
            | "Bundle"
            | "CapabilityStatement"
            | "CarePlan"
            | "CareTeam"
            | "CatalogEntry"
            | "ChargeItem"
            | "ChargeItemDefinition"
            | "Claim"
            | "ClaimResponse"
            | "ClinicalImpression"
            | "CodeSystem"
            | "Communication"
            | "CommunicationRequest"
            | "CompartmentDefinition"
            | "Composition"
            | "ConceptMap"
            | "Condition"
            | "Consent"
            | "Contract"
            | "Coverage"
            | "CoverageEligibilityRequest"
            | "CoverageEligibilityResponse"
            | "DetectedIssue"
            | "Device"
            | "DeviceDefinition"
            | "DeviceMetric"
            | "DeviceRequest"
            | "DeviceUseStatement"
            | "DiagnosticReport"
            | "DocumentManifest"
            | "DocumentReference"
            | "EffectEvidenceSynthesis"
            | "Encounter"
            | "Endpoint"
            | "EnrollmentRequest"
            | "EnrollmentResponse"
            | "EpisodeOfCare"
            | "EventDefinition"
            | "Evidence"
            | "EvidenceVariable"
            | "ExampleScenario"
            | "ExplanationOfBenefit"
            | "FamilyMemberHistory"
            | "Flag"
            | "Goal"
            | "GraphDefinition"
            | "Group"
            | "GuidanceResponse"
            | "HealthcareService"
            | "ImagingStudy"
            | "Immunization"
            | "ImmunizationEvaluation"
            | "ImmunizationRecommendation"
            | "ImplementationGuide"
            | "InsurancePlan"
            | "Invoice"
            | "Library"
            | "Linkage"
            | "List"
            | "Location"
            | "Measure"
            | "MeasureReport"
            | "Media"
            | "Medication"
            | "MedicationAdministration"
            | "MedicationDispense"
            | "MedicationKnowledge"
            | "MedicationRequest"
            | "MedicationStatement"
            | "MedicinalProduct"
            | "MedicinalProductAuthorization"
            | "MedicinalProductContraindication"
            | "MedicinalProductIndication"
            | "MedicinalProductIngredient"
            | "MedicinalProductInteraction"
            | "MedicinalProductManufactured"
            | "MedicinalProductPackaged"
            | "MedicinalProductPharmaceutical"
            | "MedicinalProductUndesirableEffect"
            | "MessageDefinition"
            | "MessageHeader"
            | "MolecularSequence"
            | "NamingSystem"
            | "NutritionOrder"
            | "Observation"
            | "ObservationDefinition"
            | "OperationDefinition"
            | "OperationOutcome"
            | "Organization"
            | "OrganizationAffiliation"
            | "Parameters"
            | "Patient"
            | "PaymentNotice"
            | "PaymentReconciliation"
            | "Person"
            | "PlanDefinition"
            | "Practitioner"
            | "PractitionerRole"
            | "Procedure"
            | "Provenance"
            | "Questionnaire"
            | "QuestionnaireResponse"
            | "RelatedPerson"
            | "RequestGroup"
            | "ResearchDefinition"
            | "ResearchElementDefinition"
            | "ResearchStudy"
            | "ResearchSubject"
            | "RiskAssessment"
            | "RiskEvidenceSynthesis"
            | "Schedule"
            | "ServiceRequest"
            | "Slot"
            | "Specimen"
            | "SpecimenDefinition"
            | "StructureDefinition"
            | "StructureMap"
            | "Subscription"
            | "Substance"
            | "SubstanceNucleicAcid"
            | "SubstancePolymer"
            | "SubstanceProtein"
            | "SubstanceReferenceInformation"
            | "SubstanceSourceMaterial"
            | "SubstanceSpecification"
            | "SupplyDelivery"
            | "SupplyRequest"
            | "Task"
            | "TerminologyCapabilities"
            | "TestReport"
            | "TestScript"
            | "ValueSet"
            | "VerificationResult"
            | "VisionPrescription"
            | "AccessPolicyV2"
            | "ClientApplication"
            | "IdentityProvider"
            | "Membership"
            | "Project"
            | "User"
            | "AdministrableProductDefinition"
            | "Citation"
            | "ClinicalUseDefinition"
            | "EvidenceReport"
            | "Ingredient"
            | "ManufacturedItemDefinition"
            | "MedicinalProductDefinition"
            | "NutritionProduct"
            | "PackagedProductDefinition"
            | "RegulatedAuthorization"
            | "SubscriptionStatus"
            | "SubscriptionTopic"
            | "SubstanceDefinition",
>(
    op: Op,
    ctx: CTX,
    fhirVersion: FHIRVersion,
    resourceType: T,
    input: Input,
): Promise<Output>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
- Op extends code | IOperation<any, any>
- Input extends any
- Output extends any
- T extends
      | "SearchParameter"
      | "Account"
      | "ActivityDefinition"
      | "AdverseEvent"
      | "AllergyIntolerance"
      | "Appointment"
      | "AppointmentResponse"
      | "AuditEvent"
      | "Basic"
      | "Binary"
      | "BiologicallyDerivedProduct"
      | "BodyStructure"
      | "Bundle"
      | "CapabilityStatement"
      | "CarePlan"
      | "CareTeam"
      | "CatalogEntry"
      | "ChargeItem"
      | "ChargeItemDefinition"
      | "Claim"
      | "ClaimResponse"
      | "ClinicalImpression"
      | "CodeSystem"
      | "Communication"
      | "CommunicationRequest"
      | "CompartmentDefinition"
      | "Composition"
      | "ConceptMap"
      | "Condition"
      | "Consent"
      | "Contract"
      | "Coverage"
      | "CoverageEligibilityRequest"
      | "CoverageEligibilityResponse"
      | "DetectedIssue"
      | "Device"
      | "DeviceDefinition"
      | "DeviceMetric"
      | "DeviceRequest"
      | "DeviceUseStatement"
      | "DiagnosticReport"
      | "DocumentManifest"
      | "DocumentReference"
      | "EffectEvidenceSynthesis"
      | "Encounter"
      | "Endpoint"
      | "EnrollmentRequest"
      | "EnrollmentResponse"
      | "EpisodeOfCare"
      | "EventDefinition"
      | "Evidence"
      | "EvidenceVariable"
      | "ExampleScenario"
      | "ExplanationOfBenefit"
      | "FamilyMemberHistory"
      | "Flag"
      | "Goal"
      | "GraphDefinition"
      | "Group"
      | "GuidanceResponse"
      | "HealthcareService"
      | "ImagingStudy"
      | "Immunization"
      | "ImmunizationEvaluation"
      | "ImmunizationRecommendation"
      | "ImplementationGuide"
      | "InsurancePlan"
      | "Invoice"
      | "Library"
      | "Linkage"
      | "List"
      | "Location"
      | "Measure"
      | "MeasureReport"
      | "Media"
      | "Medication"
      | "MedicationAdministration"
      | "MedicationDispense"
      | "MedicationKnowledge"
      | "MedicationRequest"
      | "MedicationStatement"
      | "MedicinalProduct"
      | "MedicinalProductAuthorization"
      | "MedicinalProductContraindication"
      | "MedicinalProductIndication"
      | "MedicinalProductIngredient"
      | "MedicinalProductInteraction"
      | "MedicinalProductManufactured"
      | "MedicinalProductPackaged"
      | "MedicinalProductPharmaceutical"
      | "MedicinalProductUndesirableEffect"
      | "MessageDefinition"
      | "MessageHeader"
      | "MolecularSequence"
      | "NamingSystem"
      | "NutritionOrder"
      | "Observation"
      | "ObservationDefinition"
      | "OperationDefinition"
      | "OperationOutcome"
      | "Organization"
      | "OrganizationAffiliation"
      | "Parameters"
      | "Patient"
      | "PaymentNotice"
      | "PaymentReconciliation"
      | "Person"
      | "PlanDefinition"
      | "Practitioner"
      | "PractitionerRole"
      | "Procedure"
      | "Provenance"
      | "Questionnaire"
      | "QuestionnaireResponse"
      | "RelatedPerson"
      | "RequestGroup"
      | "ResearchDefinition"
      | "ResearchElementDefinition"
      | "ResearchStudy"
      | "ResearchSubject"
      | "RiskAssessment"
      | "RiskEvidenceSynthesis"
      | "Schedule"
      | "ServiceRequest"
      | "Slot"
      | "Specimen"
      | "SpecimenDefinition"
      | "StructureDefinition"
      | "StructureMap"
      | "Subscription"
      | "Substance"
      | "SubstanceNucleicAcid"
      | "SubstancePolymer"
      | "SubstanceProtein"
      | "SubstanceReferenceInformation"
      | "SubstanceSourceMaterial"
      | "SubstanceSpecification"
      | "SupplyDelivery"
      | "SupplyRequest"
      | "Task"
      | "TerminologyCapabilities"
      | "TestReport"
      | "TestScript"
      | "ValueSet"
      | "VerificationResult"
      | "VisionPrescription"
      | "AccessPolicyV2"
      | "ClientApplication"
      | "IdentityProvider"
      | "Membership"
      | "Project"
      | "User"
      | "AdministrableProductDefinition"
      | "Citation"
      | "ClinicalUseDefinition"
      | "EvidenceReport"
      | "Ingredient"
      | "ManufacturedItemDefinition"
      | "MedicinalProductDefinition"
      | "NutritionProduct"
      | "PackagedProductDefinition"
      | "RegulatedAuthorization"
      | "SubscriptionStatus"
      | "SubscriptionTopic"
      | "SubstanceDefinition"
Parameters
- op: Op
- ctx: CTX
- fhirVersion: FHIRVersion
- resourceType: T
- input: Input
Returns Promise<Output>
Implementation of FHIRClientAsync.invoke_type
- Defined in packages/client/src/index.ts:429

patch

patch<
    FHIRVersion extends "4.0"
    | "4.3",
    T extends

            | "SearchParameter"
            | "Account"
            | "ActivityDefinition"
            | "AdverseEvent"
            | "AllergyIntolerance"
            | "Appointment"
            | "AppointmentResponse"
            | "AuditEvent"
            | "Basic"
            | "Binary"
            | "BiologicallyDerivedProduct"
            | "BodyStructure"
            | "Bundle"
            | "CapabilityStatement"
            | "CarePlan"
            | "CareTeam"
            | "CatalogEntry"
            | "ChargeItem"
            | "ChargeItemDefinition"
            | "Claim"
            | "ClaimResponse"
            | "ClinicalImpression"
            | "CodeSystem"
            | "Communication"
            | "CommunicationRequest"
            | "CompartmentDefinition"
            | "Composition"
            | "ConceptMap"
            | "Condition"
            | "Consent"
            | "Contract"
            | "Coverage"
            | "CoverageEligibilityRequest"
            | "CoverageEligibilityResponse"
            | "DetectedIssue"
            | "Device"
            | "DeviceDefinition"
            | "DeviceMetric"
            | "DeviceRequest"
            | "DeviceUseStatement"
            | "DiagnosticReport"
            | "DocumentManifest"
            | "DocumentReference"
            | "EffectEvidenceSynthesis"
            | "Encounter"
            | "Endpoint"
            | "EnrollmentRequest"
            | "EnrollmentResponse"
            | "EpisodeOfCare"
            | "EventDefinition"
            | "Evidence"
            | "EvidenceVariable"
            | "ExampleScenario"
            | "ExplanationOfBenefit"
            | "FamilyMemberHistory"
            | "Flag"
            | "Goal"
            | "GraphDefinition"
            | "Group"
            | "GuidanceResponse"
            | "HealthcareService"
            | "ImagingStudy"
            | "Immunization"
            | "ImmunizationEvaluation"
            | "ImmunizationRecommendation"
            | "ImplementationGuide"
            | "InsurancePlan"
            | "Invoice"
            | "Library"
            | "Linkage"
            | "List"
            | "Location"
            | "Measure"
            | "MeasureReport"
            | "Media"
            | "Medication"
            | "MedicationAdministration"
            | "MedicationDispense"
            | "MedicationKnowledge"
            | "MedicationRequest"
            | "MedicationStatement"
            | "MedicinalProduct"
            | "MedicinalProductAuthorization"
            | "MedicinalProductContraindication"
            | "MedicinalProductIndication"
            | "MedicinalProductIngredient"
            | "MedicinalProductInteraction"
            | "MedicinalProductManufactured"
            | "MedicinalProductPackaged"
            | "MedicinalProductPharmaceutical"
            | "MedicinalProductUndesirableEffect"
            | "MessageDefinition"
            | "MessageHeader"
            | "MolecularSequence"
            | "NamingSystem"
            | "NutritionOrder"
            | "Observation"
            | "ObservationDefinition"
            | "OperationDefinition"
            | "OperationOutcome"
            | "Organization"
            | "OrganizationAffiliation"
            | "Parameters"
            | "Patient"
            | "PaymentNotice"
            | "PaymentReconciliation"
            | "Person"
            | "PlanDefinition"
            | "Practitioner"
            | "PractitionerRole"
            | "Procedure"
            | "Provenance"
            | "Questionnaire"
            | "QuestionnaireResponse"
            | "RelatedPerson"
            | "RequestGroup"
            | "ResearchDefinition"
            | "ResearchElementDefinition"
            | "ResearchStudy"
            | "ResearchSubject"
            | "RiskAssessment"
            | "RiskEvidenceSynthesis"
            | "Schedule"
            | "ServiceRequest"
            | "Slot"
            | "Specimen"
            | "SpecimenDefinition"
            | "StructureDefinition"
            | "StructureMap"
            | "Subscription"
            | "Substance"
            | "SubstanceNucleicAcid"
            | "SubstancePolymer"
            | "SubstanceProtein"
            | "SubstanceReferenceInformation"
            | "SubstanceSourceMaterial"
            | "SubstanceSpecification"
            | "SupplyDelivery"
            | "SupplyRequest"
            | "Task"
            | "TerminologyCapabilities"
            | "TestReport"
            | "TestScript"
            | "ValueSet"
            | "VerificationResult"
            | "VisionPrescription"
            | "AccessPolicyV2"
            | "ClientApplication"
            | "IdentityProvider"
            | "Membership"
            | "Project"
            | "User"
            | "AdministrableProductDefinition"
            | "Citation"
            | "ClinicalUseDefinition"
            | "EvidenceReport"
            | "Ingredient"
            | "ManufacturedItemDefinition"
            | "MedicinalProductDefinition"
            | "NutritionProduct"
            | "PackagedProductDefinition"
            | "RegulatedAuthorization"
            | "SubscriptionStatus"
            | "SubscriptionTopic"
            | "SubstanceDefinition",
>(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    resourceType: T,
    id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>,
    patches: any,
): Promise<Resource<FHIRVersion, T>>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
- T extends
      | "SearchParameter"
      | "Account"
      | "ActivityDefinition"
      | "AdverseEvent"
      | "AllergyIntolerance"
      | "Appointment"
      | "AppointmentResponse"
      | "AuditEvent"
      | "Basic"
      | "Binary"
      | "BiologicallyDerivedProduct"
      | "BodyStructure"
      | "Bundle"
      | "CapabilityStatement"
      | "CarePlan"
      | "CareTeam"
      | "CatalogEntry"
      | "ChargeItem"
      | "ChargeItemDefinition"
      | "Claim"
      | "ClaimResponse"
      | "ClinicalImpression"
      | "CodeSystem"
      | "Communication"
      | "CommunicationRequest"
      | "CompartmentDefinition"
      | "Composition"
      | "ConceptMap"
      | "Condition"
      | "Consent"
      | "Contract"
      | "Coverage"
      | "CoverageEligibilityRequest"
      | "CoverageEligibilityResponse"
      | "DetectedIssue"
      | "Device"
      | "DeviceDefinition"
      | "DeviceMetric"
      | "DeviceRequest"
      | "DeviceUseStatement"
      | "DiagnosticReport"
      | "DocumentManifest"
      | "DocumentReference"
      | "EffectEvidenceSynthesis"
      | "Encounter"
      | "Endpoint"
      | "EnrollmentRequest"
      | "EnrollmentResponse"
      | "EpisodeOfCare"
      | "EventDefinition"
      | "Evidence"
      | "EvidenceVariable"
      | "ExampleScenario"
      | "ExplanationOfBenefit"
      | "FamilyMemberHistory"
      | "Flag"
      | "Goal"
      | "GraphDefinition"
      | "Group"
      | "GuidanceResponse"
      | "HealthcareService"
      | "ImagingStudy"
      | "Immunization"
      | "ImmunizationEvaluation"
      | "ImmunizationRecommendation"
      | "ImplementationGuide"
      | "InsurancePlan"
      | "Invoice"
      | "Library"
      | "Linkage"
      | "List"
      | "Location"
      | "Measure"
      | "MeasureReport"
      | "Media"
      | "Medication"
      | "MedicationAdministration"
      | "MedicationDispense"
      | "MedicationKnowledge"
      | "MedicationRequest"
      | "MedicationStatement"
      | "MedicinalProduct"
      | "MedicinalProductAuthorization"
      | "MedicinalProductContraindication"
      | "MedicinalProductIndication"
      | "MedicinalProductIngredient"
      | "MedicinalProductInteraction"
      | "MedicinalProductManufactured"
      | "MedicinalProductPackaged"
      | "MedicinalProductPharmaceutical"
      | "MedicinalProductUndesirableEffect"
      | "MessageDefinition"
      | "MessageHeader"
      | "MolecularSequence"
      | "NamingSystem"
      | "NutritionOrder"
      | "Observation"
      | "ObservationDefinition"
      | "OperationDefinition"
      | "OperationOutcome"
      | "Organization"
      | "OrganizationAffiliation"
      | "Parameters"
      | "Patient"
      | "PaymentNotice"
      | "PaymentReconciliation"
      | "Person"
      | "PlanDefinition"
      | "Practitioner"
      | "PractitionerRole"
      | "Procedure"
      | "Provenance"
      | "Questionnaire"
      | "QuestionnaireResponse"
      | "RelatedPerson"
      | "RequestGroup"
      | "ResearchDefinition"
      | "ResearchElementDefinition"
      | "ResearchStudy"
      | "ResearchSubject"
      | "RiskAssessment"
      | "RiskEvidenceSynthesis"
      | "Schedule"
      | "ServiceRequest"
      | "Slot"
      | "Specimen"
      | "SpecimenDefinition"
      | "StructureDefinition"
      | "StructureMap"
      | "Subscription"
      | "Substance"
      | "SubstanceNucleicAcid"
      | "SubstancePolymer"
      | "SubstanceProtein"
      | "SubstanceReferenceInformation"
      | "SubstanceSourceMaterial"
      | "SubstanceSpecification"
      | "SupplyDelivery"
      | "SupplyRequest"
      | "Task"
      | "TerminologyCapabilities"
      | "TestReport"
      | "TestScript"
      | "ValueSet"
      | "VerificationResult"
      | "VisionPrescription"
      | "AccessPolicyV2"
      | "ClientApplication"
      | "IdentityProvider"
      | "Membership"
      | "Project"
      | "User"
      | "AdministrableProductDefinition"
      | "Citation"
      | "ClinicalUseDefinition"
      | "EvidenceReport"
      | "Ingredient"
      | "ManufacturedItemDefinition"
      | "MedicinalProductDefinition"
      | "NutritionProduct"
      | "PackagedProductDefinition"
      | "RegulatedAuthorization"
      | "SubscriptionStatus"
      | "SubscriptionTopic"
      | "SubstanceDefinition"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- resourceType: T
- id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>
- patches: any
Returns Promise<Resource<FHIRVersion, T>>
Implementation of FHIRClientAsync.patch
- Defined in packages/client/src/index.ts:190

read

read<
    FHIRVersion extends "4.0"
    | "4.3",
    T extends

            | "SearchParameter"
            | "Account"
            | "ActivityDefinition"
            | "AdverseEvent"
            | "AllergyIntolerance"
            | "Appointment"
            | "AppointmentResponse"
            | "AuditEvent"
            | "Basic"
            | "Binary"
            | "BiologicallyDerivedProduct"
            | "BodyStructure"
            | "Bundle"
            | "CapabilityStatement"
            | "CarePlan"
            | "CareTeam"
            | "CatalogEntry"
            | "ChargeItem"
            | "ChargeItemDefinition"
            | "Claim"
            | "ClaimResponse"
            | "ClinicalImpression"
            | "CodeSystem"
            | "Communication"
            | "CommunicationRequest"
            | "CompartmentDefinition"
            | "Composition"
            | "ConceptMap"
            | "Condition"
            | "Consent"
            | "Contract"
            | "Coverage"
            | "CoverageEligibilityRequest"
            | "CoverageEligibilityResponse"
            | "DetectedIssue"
            | "Device"
            | "DeviceDefinition"
            | "DeviceMetric"
            | "DeviceRequest"
            | "DeviceUseStatement"
            | "DiagnosticReport"
            | "DocumentManifest"
            | "DocumentReference"
            | "EffectEvidenceSynthesis"
            | "Encounter"
            | "Endpoint"
            | "EnrollmentRequest"
            | "EnrollmentResponse"
            | "EpisodeOfCare"
            | "EventDefinition"
            | "Evidence"
            | "EvidenceVariable"
            | "ExampleScenario"
            | "ExplanationOfBenefit"
            | "FamilyMemberHistory"
            | "Flag"
            | "Goal"
            | "GraphDefinition"
            | "Group"
            | "GuidanceResponse"
            | "HealthcareService"
            | "ImagingStudy"
            | "Immunization"
            | "ImmunizationEvaluation"
            | "ImmunizationRecommendation"
            | "ImplementationGuide"
            | "InsurancePlan"
            | "Invoice"
            | "Library"
            | "Linkage"
            | "List"
            | "Location"
            | "Measure"
            | "MeasureReport"
            | "Media"
            | "Medication"
            | "MedicationAdministration"
            | "MedicationDispense"
            | "MedicationKnowledge"
            | "MedicationRequest"
            | "MedicationStatement"
            | "MedicinalProduct"
            | "MedicinalProductAuthorization"
            | "MedicinalProductContraindication"
            | "MedicinalProductIndication"
            | "MedicinalProductIngredient"
            | "MedicinalProductInteraction"
            | "MedicinalProductManufactured"
            | "MedicinalProductPackaged"
            | "MedicinalProductPharmaceutical"
            | "MedicinalProductUndesirableEffect"
            | "MessageDefinition"
            | "MessageHeader"
            | "MolecularSequence"
            | "NamingSystem"
            | "NutritionOrder"
            | "Observation"
            | "ObservationDefinition"
            | "OperationDefinition"
            | "OperationOutcome"
            | "Organization"
            | "OrganizationAffiliation"
            | "Parameters"
            | "Patient"
            | "PaymentNotice"
            | "PaymentReconciliation"
            | "Person"
            | "PlanDefinition"
            | "Practitioner"
            | "PractitionerRole"
            | "Procedure"
            | "Provenance"
            | "Questionnaire"
            | "QuestionnaireResponse"
            | "RelatedPerson"
            | "RequestGroup"
            | "ResearchDefinition"
            | "ResearchElementDefinition"
            | "ResearchStudy"
            | "ResearchSubject"
            | "RiskAssessment"
            | "RiskEvidenceSynthesis"
            | "Schedule"
            | "ServiceRequest"
            | "Slot"
            | "Specimen"
            | "SpecimenDefinition"
            | "StructureDefinition"
            | "StructureMap"
            | "Subscription"
            | "Substance"
            | "SubstanceNucleicAcid"
            | "SubstancePolymer"
            | "SubstanceProtein"
            | "SubstanceReferenceInformation"
            | "SubstanceSourceMaterial"
            | "SubstanceSpecification"
            | "SupplyDelivery"
            | "SupplyRequest"
            | "Task"
            | "TerminologyCapabilities"
            | "TestReport"
            | "TestScript"
            | "ValueSet"
            | "VerificationResult"
            | "VisionPrescription"
            | "AccessPolicyV2"
            | "ClientApplication"
            | "IdentityProvider"
            | "Membership"
            | "Project"
            | "User"
            | "AdministrableProductDefinition"
            | "Citation"
            | "ClinicalUseDefinition"
            | "EvidenceReport"
            | "Ingredient"
            | "ManufacturedItemDefinition"
            | "MedicinalProductDefinition"
            | "NutritionProduct"
            | "PackagedProductDefinition"
            | "RegulatedAuthorization"
            | "SubscriptionStatus"
            | "SubscriptionTopic"
            | "SubstanceDefinition",
>(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    resourceType: T,
    id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>,
): Promise<Resource<FHIRVersion, T> | undefined>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
- T extends
      | "SearchParameter"
      | "Account"
      | "ActivityDefinition"
      | "AdverseEvent"
      | "AllergyIntolerance"
      | "Appointment"
      | "AppointmentResponse"
      | "AuditEvent"
      | "Basic"
      | "Binary"
      | "BiologicallyDerivedProduct"
      | "BodyStructure"
      | "Bundle"
      | "CapabilityStatement"
      | "CarePlan"
      | "CareTeam"
      | "CatalogEntry"
      | "ChargeItem"
      | "ChargeItemDefinition"
      | "Claim"
      | "ClaimResponse"
      | "ClinicalImpression"
      | "CodeSystem"
      | "Communication"
      | "CommunicationRequest"
      | "CompartmentDefinition"
      | "Composition"
      | "ConceptMap"
      | "Condition"
      | "Consent"
      | "Contract"
      | "Coverage"
      | "CoverageEligibilityRequest"
      | "CoverageEligibilityResponse"
      | "DetectedIssue"
      | "Device"
      | "DeviceDefinition"
      | "DeviceMetric"
      | "DeviceRequest"
      | "DeviceUseStatement"
      | "DiagnosticReport"
      | "DocumentManifest"
      | "DocumentReference"
      | "EffectEvidenceSynthesis"
      | "Encounter"
      | "Endpoint"
      | "EnrollmentRequest"
      | "EnrollmentResponse"
      | "EpisodeOfCare"
      | "EventDefinition"
      | "Evidence"
      | "EvidenceVariable"
      | "ExampleScenario"
      | "ExplanationOfBenefit"
      | "FamilyMemberHistory"
      | "Flag"
      | "Goal"
      | "GraphDefinition"
      | "Group"
      | "GuidanceResponse"
      | "HealthcareService"
      | "ImagingStudy"
      | "Immunization"
      | "ImmunizationEvaluation"
      | "ImmunizationRecommendation"
      | "ImplementationGuide"
      | "InsurancePlan"
      | "Invoice"
      | "Library"
      | "Linkage"
      | "List"
      | "Location"
      | "Measure"
      | "MeasureReport"
      | "Media"
      | "Medication"
      | "MedicationAdministration"
      | "MedicationDispense"
      | "MedicationKnowledge"
      | "MedicationRequest"
      | "MedicationStatement"
      | "MedicinalProduct"
      | "MedicinalProductAuthorization"
      | "MedicinalProductContraindication"
      | "MedicinalProductIndication"
      | "MedicinalProductIngredient"
      | "MedicinalProductInteraction"
      | "MedicinalProductManufactured"
      | "MedicinalProductPackaged"
      | "MedicinalProductPharmaceutical"
      | "MedicinalProductUndesirableEffect"
      | "MessageDefinition"
      | "MessageHeader"
      | "MolecularSequence"
      | "NamingSystem"
      | "NutritionOrder"
      | "Observation"
      | "ObservationDefinition"
      | "OperationDefinition"
      | "OperationOutcome"
      | "Organization"
      | "OrganizationAffiliation"
      | "Parameters"
      | "Patient"
      | "PaymentNotice"
      | "PaymentReconciliation"
      | "Person"
      | "PlanDefinition"
      | "Practitioner"
      | "PractitionerRole"
      | "Procedure"
      | "Provenance"
      | "Questionnaire"
      | "QuestionnaireResponse"
      | "RelatedPerson"
      | "RequestGroup"
      | "ResearchDefinition"
      | "ResearchElementDefinition"
      | "ResearchStudy"
      | "ResearchSubject"
      | "RiskAssessment"
      | "RiskEvidenceSynthesis"
      | "Schedule"
      | "ServiceRequest"
      | "Slot"
      | "Specimen"
      | "SpecimenDefinition"
      | "StructureDefinition"
      | "StructureMap"
      | "Subscription"
      | "Substance"
      | "SubstanceNucleicAcid"
      | "SubstancePolymer"
      | "SubstanceProtein"
      | "SubstanceReferenceInformation"
      | "SubstanceSourceMaterial"
      | "SubstanceSpecification"
      | "SupplyDelivery"
      | "SupplyRequest"
      | "Task"
      | "TerminologyCapabilities"
      | "TestReport"
      | "TestScript"
      | "ValueSet"
      | "VerificationResult"
      | "VisionPrescription"
      | "AccessPolicyV2"
      | "ClientApplication"
      | "IdentityProvider"
      | "Membership"
      | "Project"
      | "User"
      | "AdministrableProductDefinition"
      | "Citation"
      | "ClinicalUseDefinition"
      | "EvidenceReport"
      | "Ingredient"
      | "ManufacturedItemDefinition"
      | "MedicinalProductDefinition"
      | "NutritionProduct"
      | "PackagedProductDefinition"
      | "RegulatedAuthorization"
      | "SubscriptionStatus"
      | "SubscriptionTopic"
      | "SubstanceDefinition"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- resourceType: T
- id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>
Returns Promise<Resource<FHIRVersion, T> | undefined>
Implementation of FHIRClientAsync.read
- Defined in packages/client/src/index.ts:212

request

request<Version extends "4.0" | "4.3", I extends AllInteractions>(
ctx: CTX,
request: FHIRRequest<Version, I>,
): Promise<FHIRResponse<Version, "error" | I>>
Type Parameters
- Version extends "4.0" | "4.3"
- I extends AllInteractions
Parameters
- ctx: CTX
- request: FHIRRequest<Version, I>
Returns Promise<FHIRResponse<Version, "error" | I>>
Implementation of FHIRClientAsync.request
- Defined in packages/client/src/index.ts:32

search_system

search_system<FHIRVersion extends "4.0" | "4.3">(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    parameters: string | ParsedParameter<string | number>[],
): Promise<
    {
        resources: Resource<FHIRVersion, ResourceType<FHIRVersion>>[];
        total?: number;
    },
>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- parameters: string | ParsedParameter<string | number>[]
Returns Promise<
    {
        resources: Resource<FHIRVersion, ResourceType<FHIRVersion>>[];
        total?: number;
    },
>
Implementation of FHIRClientAsync.search_system
- Defined in packages/client/src/index.ts:62

search_type

search_type<
    Version extends "4.0"
    | "4.3",
    T extends

            | "SearchParameter"
            | "Account"
            | "ActivityDefinition"
            | "AdverseEvent"
            | "AllergyIntolerance"
            | "Appointment"
            | "AppointmentResponse"
            | "AuditEvent"
            | "Basic"
            | "Binary"
            | "BiologicallyDerivedProduct"
            | "BodyStructure"
            | "Bundle"
            | "CapabilityStatement"
            | "CarePlan"
            | "CareTeam"
            | "CatalogEntry"
            | "ChargeItem"
            | "ChargeItemDefinition"
            | "Claim"
            | "ClaimResponse"
            | "ClinicalImpression"
            | "CodeSystem"
            | "Communication"
            | "CommunicationRequest"
            | "CompartmentDefinition"
            | "Composition"
            | "ConceptMap"
            | "Condition"
            | "Consent"
            | "Contract"
            | "Coverage"
            | "CoverageEligibilityRequest"
            | "CoverageEligibilityResponse"
            | "DetectedIssue"
            | "Device"
            | "DeviceDefinition"
            | "DeviceMetric"
            | "DeviceRequest"
            | "DeviceUseStatement"
            | "DiagnosticReport"
            | "DocumentManifest"
            | "DocumentReference"
            | "EffectEvidenceSynthesis"
            | "Encounter"
            | "Endpoint"
            | "EnrollmentRequest"
            | "EnrollmentResponse"
            | "EpisodeOfCare"
            | "EventDefinition"
            | "Evidence"
            | "EvidenceVariable"
            | "ExampleScenario"
            | "ExplanationOfBenefit"
            | "FamilyMemberHistory"
            | "Flag"
            | "Goal"
            | "GraphDefinition"
            | "Group"
            | "GuidanceResponse"
            | "HealthcareService"
            | "ImagingStudy"
            | "Immunization"
            | "ImmunizationEvaluation"
            | "ImmunizationRecommendation"
            | "ImplementationGuide"
            | "InsurancePlan"
            | "Invoice"
            | "Library"
            | "Linkage"
            | "List"
            | "Location"
            | "Measure"
            | "MeasureReport"
            | "Media"
            | "Medication"
            | "MedicationAdministration"
            | "MedicationDispense"
            | "MedicationKnowledge"
            | "MedicationRequest"
            | "MedicationStatement"
            | "MedicinalProduct"
            | "MedicinalProductAuthorization"
            | "MedicinalProductContraindication"
            | "MedicinalProductIndication"
            | "MedicinalProductIngredient"
            | "MedicinalProductInteraction"
            | "MedicinalProductManufactured"
            | "MedicinalProductPackaged"
            | "MedicinalProductPharmaceutical"
            | "MedicinalProductUndesirableEffect"
            | "MessageDefinition"
            | "MessageHeader"
            | "MolecularSequence"
            | "NamingSystem"
            | "NutritionOrder"
            | "Observation"
            | "ObservationDefinition"
            | "OperationDefinition"
            | "OperationOutcome"
            | "Organization"
            | "OrganizationAffiliation"
            | "Parameters"
            | "Patient"
            | "PaymentNotice"
            | "PaymentReconciliation"
            | "Person"
            | "PlanDefinition"
            | "Practitioner"
            | "PractitionerRole"
            | "Procedure"
            | "Provenance"
            | "Questionnaire"
            | "QuestionnaireResponse"
            | "RelatedPerson"
            | "RequestGroup"
            | "ResearchDefinition"
            | "ResearchElementDefinition"
            | "ResearchStudy"
            | "ResearchSubject"
            | "RiskAssessment"
            | "RiskEvidenceSynthesis"
            | "Schedule"
            | "ServiceRequest"
            | "Slot"
            | "Specimen"
            | "SpecimenDefinition"
            | "StructureDefinition"
            | "StructureMap"
            | "Subscription"
            | "Substance"
            | "SubstanceNucleicAcid"
            | "SubstancePolymer"
            | "SubstanceProtein"
            | "SubstanceReferenceInformation"
            | "SubstanceSourceMaterial"
            | "SubstanceSpecification"
            | "SupplyDelivery"
            | "SupplyRequest"
            | "Task"
            | "TerminologyCapabilities"
            | "TestReport"
            | "TestScript"
            | "ValueSet"
            | "VerificationResult"
            | "VisionPrescription"
            | "AccessPolicyV2"
            | "ClientApplication"
            | "IdentityProvider"
            | "Membership"
            | "Project"
            | "User"
            | "AdministrableProductDefinition"
            | "Citation"
            | "ClinicalUseDefinition"
            | "EvidenceReport"
            | "Ingredient"
            | "ManufacturedItemDefinition"
            | "MedicinalProductDefinition"
            | "NutritionProduct"
            | "PackagedProductDefinition"
            | "RegulatedAuthorization"
            | "SubscriptionStatus"
            | "SubscriptionTopic"
            | "SubstanceDefinition",
>(
    ctx: CTX,
    fhirVersion: Version,
    type: T,
    parameters: string | ParsedParameter<string | number>[],
): Promise<{ resources: Resource<Version, T>[]; total?: number }>
Type Parameters
- Version extends "4.0" | "4.3"
- T extends
      | "SearchParameter"
      | "Account"
      | "ActivityDefinition"
      | "AdverseEvent"
      | "AllergyIntolerance"
      | "Appointment"
      | "AppointmentResponse"
      | "AuditEvent"
      | "Basic"
      | "Binary"
      | "BiologicallyDerivedProduct"
      | "BodyStructure"
      | "Bundle"
      | "CapabilityStatement"
      | "CarePlan"
      | "CareTeam"
      | "CatalogEntry"
      | "ChargeItem"
      | "ChargeItemDefinition"
      | "Claim"
      | "ClaimResponse"
      | "ClinicalImpression"
      | "CodeSystem"
      | "Communication"
      | "CommunicationRequest"
      | "CompartmentDefinition"
      | "Composition"
      | "ConceptMap"
      | "Condition"
      | "Consent"
      | "Contract"
      | "Coverage"
      | "CoverageEligibilityRequest"
      | "CoverageEligibilityResponse"
      | "DetectedIssue"
      | "Device"
      | "DeviceDefinition"
      | "DeviceMetric"
      | "DeviceRequest"
      | "DeviceUseStatement"
      | "DiagnosticReport"
      | "DocumentManifest"
      | "DocumentReference"
      | "EffectEvidenceSynthesis"
      | "Encounter"
      | "Endpoint"
      | "EnrollmentRequest"
      | "EnrollmentResponse"
      | "EpisodeOfCare"
      | "EventDefinition"
      | "Evidence"
      | "EvidenceVariable"
      | "ExampleScenario"
      | "ExplanationOfBenefit"
      | "FamilyMemberHistory"
      | "Flag"
      | "Goal"
      | "GraphDefinition"
      | "Group"
      | "GuidanceResponse"
      | "HealthcareService"
      | "ImagingStudy"
      | "Immunization"
      | "ImmunizationEvaluation"
      | "ImmunizationRecommendation"
      | "ImplementationGuide"
      | "InsurancePlan"
      | "Invoice"
      | "Library"
      | "Linkage"
      | "List"
      | "Location"
      | "Measure"
      | "MeasureReport"
      | "Media"
      | "Medication"
      | "MedicationAdministration"
      | "MedicationDispense"
      | "MedicationKnowledge"
      | "MedicationRequest"
      | "MedicationStatement"
      | "MedicinalProduct"
      | "MedicinalProductAuthorization"
      | "MedicinalProductContraindication"
      | "MedicinalProductIndication"
      | "MedicinalProductIngredient"
      | "MedicinalProductInteraction"
      | "MedicinalProductManufactured"
      | "MedicinalProductPackaged"
      | "MedicinalProductPharmaceutical"
      | "MedicinalProductUndesirableEffect"
      | "MessageDefinition"
      | "MessageHeader"
      | "MolecularSequence"
      | "NamingSystem"
      | "NutritionOrder"
      | "Observation"
      | "ObservationDefinition"
      | "OperationDefinition"
      | "OperationOutcome"
      | "Organization"
      | "OrganizationAffiliation"
      | "Parameters"
      | "Patient"
      | "PaymentNotice"
      | "PaymentReconciliation"
      | "Person"
      | "PlanDefinition"
      | "Practitioner"
      | "PractitionerRole"
      | "Procedure"
      | "Provenance"
      | "Questionnaire"
      | "QuestionnaireResponse"
      | "RelatedPerson"
      | "RequestGroup"
      | "ResearchDefinition"
      | "ResearchElementDefinition"
      | "ResearchStudy"
      | "ResearchSubject"
      | "RiskAssessment"
      | "RiskEvidenceSynthesis"
      | "Schedule"
      | "ServiceRequest"
      | "Slot"
      | "Specimen"
      | "SpecimenDefinition"
      | "StructureDefinition"
      | "StructureMap"
      | "Subscription"
      | "Substance"
      | "SubstanceNucleicAcid"
      | "SubstancePolymer"
      | "SubstanceProtein"
      | "SubstanceReferenceInformation"
      | "SubstanceSourceMaterial"
      | "SubstanceSpecification"
      | "SupplyDelivery"
      | "SupplyRequest"
      | "Task"
      | "TerminologyCapabilities"
      | "TestReport"
      | "TestScript"
      | "ValueSet"
      | "VerificationResult"
      | "VisionPrescription"
      | "AccessPolicyV2"
      | "ClientApplication"
      | "IdentityProvider"
      | "Membership"
      | "Project"
      | "User"
      | "AdministrableProductDefinition"
      | "Citation"
      | "ClinicalUseDefinition"
      | "EvidenceReport"
      | "Ingredient"
      | "ManufacturedItemDefinition"
      | "MedicinalProductDefinition"
      | "NutritionProduct"
      | "PackagedProductDefinition"
      | "RegulatedAuthorization"
      | "SubscriptionStatus"
      | "SubscriptionTopic"
      | "SubstanceDefinition"
Parameters
- ctx: CTX
- fhirVersion: Version
- type: T
- parameters: string | ParsedParameter<string | number>[]
Returns Promise<{ resources: Resource<Version, T>[]; total?: number }>
Implementation of FHIRClientAsync.search_type
- Defined in packages/client/src/index.ts:90

transaction

transaction<FHIRVersion extends "4.0" | "4.3">(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    bundle: Resource<FHIRVersion, "Bundle">,
): Promise<Resource<FHIRVersion, "Bundle">>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- bundle: Resource<FHIRVersion, "Bundle">
Returns Promise<Resource<FHIRVersion, "Bundle">>
Implementation of FHIRClientAsync.transaction
- Defined in packages/client/src/index.ts:509

update

update<
    FHIRVersion extends "4.0"
    | "4.3",
    T extends

            | "SearchParameter"
            | "Account"
            | "ActivityDefinition"
            | "AdverseEvent"
            | "AllergyIntolerance"
            | "Appointment"
            | "AppointmentResponse"
            | "AuditEvent"
            | "Basic"
            | "Binary"
            | "BiologicallyDerivedProduct"
            | "BodyStructure"
            | "Bundle"
            | "CapabilityStatement"
            | "CarePlan"
            | "CareTeam"
            | "CatalogEntry"
            | "ChargeItem"
            | "ChargeItemDefinition"
            | "Claim"
            | "ClaimResponse"
            | "ClinicalImpression"
            | "CodeSystem"
            | "Communication"
            | "CommunicationRequest"
            | "CompartmentDefinition"
            | "Composition"
            | "ConceptMap"
            | "Condition"
            | "Consent"
            | "Contract"
            | "Coverage"
            | "CoverageEligibilityRequest"
            | "CoverageEligibilityResponse"
            | "DetectedIssue"
            | "Device"
            | "DeviceDefinition"
            | "DeviceMetric"
            | "DeviceRequest"
            | "DeviceUseStatement"
            | "DiagnosticReport"
            | "DocumentManifest"
            | "DocumentReference"
            | "EffectEvidenceSynthesis"
            | "Encounter"
            | "Endpoint"
            | "EnrollmentRequest"
            | "EnrollmentResponse"
            | "EpisodeOfCare"
            | "EventDefinition"
            | "Evidence"
            | "EvidenceVariable"
            | "ExampleScenario"
            | "ExplanationOfBenefit"
            | "FamilyMemberHistory"
            | "Flag"
            | "Goal"
            | "GraphDefinition"
            | "Group"
            | "GuidanceResponse"
            | "HealthcareService"
            | "ImagingStudy"
            | "Immunization"
            | "ImmunizationEvaluation"
            | "ImmunizationRecommendation"
            | "ImplementationGuide"
            | "InsurancePlan"
            | "Invoice"
            | "Library"
            | "Linkage"
            | "List"
            | "Location"
            | "Measure"
            | "MeasureReport"
            | "Media"
            | "Medication"
            | "MedicationAdministration"
            | "MedicationDispense"
            | "MedicationKnowledge"
            | "MedicationRequest"
            | "MedicationStatement"
            | "MedicinalProduct"
            | "MedicinalProductAuthorization"
            | "MedicinalProductContraindication"
            | "MedicinalProductIndication"
            | "MedicinalProductIngredient"
            | "MedicinalProductInteraction"
            | "MedicinalProductManufactured"
            | "MedicinalProductPackaged"
            | "MedicinalProductPharmaceutical"
            | "MedicinalProductUndesirableEffect"
            | "MessageDefinition"
            | "MessageHeader"
            | "MolecularSequence"
            | "NamingSystem"
            | "NutritionOrder"
            | "Observation"
            | "ObservationDefinition"
            | "OperationDefinition"
            | "OperationOutcome"
            | "Organization"
            | "OrganizationAffiliation"
            | "Parameters"
            | "Patient"
            | "PaymentNotice"
            | "PaymentReconciliation"
            | "Person"
            | "PlanDefinition"
            | "Practitioner"
            | "PractitionerRole"
            | "Procedure"
            | "Provenance"
            | "Questionnaire"
            | "QuestionnaireResponse"
            | "RelatedPerson"
            | "RequestGroup"
            | "ResearchDefinition"
            | "ResearchElementDefinition"
            | "ResearchStudy"
            | "ResearchSubject"
            | "RiskAssessment"
            | "RiskEvidenceSynthesis"
            | "Schedule"
            | "ServiceRequest"
            | "Slot"
            | "Specimen"
            | "SpecimenDefinition"
            | "StructureDefinition"
            | "StructureMap"
            | "Subscription"
            | "Substance"
            | "SubstanceNucleicAcid"
            | "SubstancePolymer"
            | "SubstanceProtein"
            | "SubstanceReferenceInformation"
            | "SubstanceSourceMaterial"
            | "SubstanceSpecification"
            | "SupplyDelivery"
            | "SupplyRequest"
            | "Task"
            | "TerminologyCapabilities"
            | "TestReport"
            | "TestScript"
            | "ValueSet"
            | "VerificationResult"
            | "VisionPrescription"
            | "AccessPolicyV2"
            | "ClientApplication"
            | "IdentityProvider"
            | "Membership"
            | "Project"
            | "User"
            | "AdministrableProductDefinition"
            | "Citation"
            | "ClinicalUseDefinition"
            | "EvidenceReport"
            | "Ingredient"
            | "ManufacturedItemDefinition"
            | "MedicinalProductDefinition"
            | "NutritionProduct"
            | "PackagedProductDefinition"
            | "RegulatedAuthorization"
            | "SubscriptionStatus"
            | "SubscriptionTopic"
            | "SubstanceDefinition",
>(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    resourceType: T,
    id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>,
    resource: Resource<FHIRVersion, T>,
): Promise<Resource<FHIRVersion, T>>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
- T extends
      | "SearchParameter"
      | "Account"
      | "ActivityDefinition"
      | "AdverseEvent"
      | "AllergyIntolerance"
      | "Appointment"
      | "AppointmentResponse"
      | "AuditEvent"
      | "Basic"
      | "Binary"
      | "BiologicallyDerivedProduct"
      | "BodyStructure"
      | "Bundle"
      | "CapabilityStatement"
      | "CarePlan"
      | "CareTeam"
      | "CatalogEntry"
      | "ChargeItem"
      | "ChargeItemDefinition"
      | "Claim"
      | "ClaimResponse"
      | "ClinicalImpression"
      | "CodeSystem"
      | "Communication"
      | "CommunicationRequest"
      | "CompartmentDefinition"
      | "Composition"
      | "ConceptMap"
      | "Condition"
      | "Consent"
      | "Contract"
      | "Coverage"
      | "CoverageEligibilityRequest"
      | "CoverageEligibilityResponse"
      | "DetectedIssue"
      | "Device"
      | "DeviceDefinition"
      | "DeviceMetric"
      | "DeviceRequest"
      | "DeviceUseStatement"
      | "DiagnosticReport"
      | "DocumentManifest"
      | "DocumentReference"
      | "EffectEvidenceSynthesis"
      | "Encounter"
      | "Endpoint"
      | "EnrollmentRequest"
      | "EnrollmentResponse"
      | "EpisodeOfCare"
      | "EventDefinition"
      | "Evidence"
      | "EvidenceVariable"
      | "ExampleScenario"
      | "ExplanationOfBenefit"
      | "FamilyMemberHistory"
      | "Flag"
      | "Goal"
      | "GraphDefinition"
      | "Group"
      | "GuidanceResponse"
      | "HealthcareService"
      | "ImagingStudy"
      | "Immunization"
      | "ImmunizationEvaluation"
      | "ImmunizationRecommendation"
      | "ImplementationGuide"
      | "InsurancePlan"
      | "Invoice"
      | "Library"
      | "Linkage"
      | "List"
      | "Location"
      | "Measure"
      | "MeasureReport"
      | "Media"
      | "Medication"
      | "MedicationAdministration"
      | "MedicationDispense"
      | "MedicationKnowledge"
      | "MedicationRequest"
      | "MedicationStatement"
      | "MedicinalProduct"
      | "MedicinalProductAuthorization"
      | "MedicinalProductContraindication"
      | "MedicinalProductIndication"
      | "MedicinalProductIngredient"
      | "MedicinalProductInteraction"
      | "MedicinalProductManufactured"
      | "MedicinalProductPackaged"
      | "MedicinalProductPharmaceutical"
      | "MedicinalProductUndesirableEffect"
      | "MessageDefinition"
      | "MessageHeader"
      | "MolecularSequence"
      | "NamingSystem"
      | "NutritionOrder"
      | "Observation"
      | "ObservationDefinition"
      | "OperationDefinition"
      | "OperationOutcome"
      | "Organization"
      | "OrganizationAffiliation"
      | "Parameters"
      | "Patient"
      | "PaymentNotice"
      | "PaymentReconciliation"
      | "Person"
      | "PlanDefinition"
      | "Practitioner"
      | "PractitionerRole"
      | "Procedure"
      | "Provenance"
      | "Questionnaire"
      | "QuestionnaireResponse"
      | "RelatedPerson"
      | "RequestGroup"
      | "ResearchDefinition"
      | "ResearchElementDefinition"
      | "ResearchStudy"
      | "ResearchSubject"
      | "RiskAssessment"
      | "RiskEvidenceSynthesis"
      | "Schedule"
      | "ServiceRequest"
      | "Slot"
      | "Specimen"
      | "SpecimenDefinition"
      | "StructureDefinition"
      | "StructureMap"
      | "Subscription"
      | "Substance"
      | "SubstanceNucleicAcid"
      | "SubstancePolymer"
      | "SubstanceProtein"
      | "SubstanceReferenceInformation"
      | "SubstanceSourceMaterial"
      | "SubstanceSpecification"
      | "SupplyDelivery"
      | "SupplyRequest"
      | "Task"
      | "TerminologyCapabilities"
      | "TestReport"
      | "TestScript"
      | "ValueSet"
      | "VerificationResult"
      | "VisionPrescription"
      | "AccessPolicyV2"
      | "ClientApplication"
      | "IdentityProvider"
      | "Membership"
      | "Project"
      | "User"
      | "AdministrableProductDefinition"
      | "Citation"
      | "ClinicalUseDefinition"
      | "EvidenceReport"
      | "Ingredient"
      | "ManufacturedItemDefinition"
      | "MedicinalProductDefinition"
      | "NutritionProduct"
      | "PackagedProductDefinition"
      | "RegulatedAuthorization"
      | "SubscriptionStatus"
      | "SubscriptionTopic"
      | "SubstanceDefinition"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- resourceType: T
- id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>
- resource: Resource<FHIRVersion, T>
Returns Promise<Resource<FHIRVersion, T>>
Implementation of FHIRClientAsync.update
- Defined in packages/client/src/index.ts:166

vread

vread<
    FHIRVersion extends "4.0"
    | "4.3",
    T extends

            | "SearchParameter"
            | "Account"
            | "ActivityDefinition"
            | "AdverseEvent"
            | "AllergyIntolerance"
            | "Appointment"
            | "AppointmentResponse"
            | "AuditEvent"
            | "Basic"
            | "Binary"
            | "BiologicallyDerivedProduct"
            | "BodyStructure"
            | "Bundle"
            | "CapabilityStatement"
            | "CarePlan"
            | "CareTeam"
            | "CatalogEntry"
            | "ChargeItem"
            | "ChargeItemDefinition"
            | "Claim"
            | "ClaimResponse"
            | "ClinicalImpression"
            | "CodeSystem"
            | "Communication"
            | "CommunicationRequest"
            | "CompartmentDefinition"
            | "Composition"
            | "ConceptMap"
            | "Condition"
            | "Consent"
            | "Contract"
            | "Coverage"
            | "CoverageEligibilityRequest"
            | "CoverageEligibilityResponse"
            | "DetectedIssue"
            | "Device"
            | "DeviceDefinition"
            | "DeviceMetric"
            | "DeviceRequest"
            | "DeviceUseStatement"
            | "DiagnosticReport"
            | "DocumentManifest"
            | "DocumentReference"
            | "EffectEvidenceSynthesis"
            | "Encounter"
            | "Endpoint"
            | "EnrollmentRequest"
            | "EnrollmentResponse"
            | "EpisodeOfCare"
            | "EventDefinition"
            | "Evidence"
            | "EvidenceVariable"
            | "ExampleScenario"
            | "ExplanationOfBenefit"
            | "FamilyMemberHistory"
            | "Flag"
            | "Goal"
            | "GraphDefinition"
            | "Group"
            | "GuidanceResponse"
            | "HealthcareService"
            | "ImagingStudy"
            | "Immunization"
            | "ImmunizationEvaluation"
            | "ImmunizationRecommendation"
            | "ImplementationGuide"
            | "InsurancePlan"
            | "Invoice"
            | "Library"
            | "Linkage"
            | "List"
            | "Location"
            | "Measure"
            | "MeasureReport"
            | "Media"
            | "Medication"
            | "MedicationAdministration"
            | "MedicationDispense"
            | "MedicationKnowledge"
            | "MedicationRequest"
            | "MedicationStatement"
            | "MedicinalProduct"
            | "MedicinalProductAuthorization"
            | "MedicinalProductContraindication"
            | "MedicinalProductIndication"
            | "MedicinalProductIngredient"
            | "MedicinalProductInteraction"
            | "MedicinalProductManufactured"
            | "MedicinalProductPackaged"
            | "MedicinalProductPharmaceutical"
            | "MedicinalProductUndesirableEffect"
            | "MessageDefinition"
            | "MessageHeader"
            | "MolecularSequence"
            | "NamingSystem"
            | "NutritionOrder"
            | "Observation"
            | "ObservationDefinition"
            | "OperationDefinition"
            | "OperationOutcome"
            | "Organization"
            | "OrganizationAffiliation"
            | "Parameters"
            | "Patient"
            | "PaymentNotice"
            | "PaymentReconciliation"
            | "Person"
            | "PlanDefinition"
            | "Practitioner"
            | "PractitionerRole"
            | "Procedure"
            | "Provenance"
            | "Questionnaire"
            | "QuestionnaireResponse"
            | "RelatedPerson"
            | "RequestGroup"
            | "ResearchDefinition"
            | "ResearchElementDefinition"
            | "ResearchStudy"
            | "ResearchSubject"
            | "RiskAssessment"
            | "RiskEvidenceSynthesis"
            | "Schedule"
            | "ServiceRequest"
            | "Slot"
            | "Specimen"
            | "SpecimenDefinition"
            | "StructureDefinition"
            | "StructureMap"
            | "Subscription"
            | "Substance"
            | "SubstanceNucleicAcid"
            | "SubstancePolymer"
            | "SubstanceProtein"
            | "SubstanceReferenceInformation"
            | "SubstanceSourceMaterial"
            | "SubstanceSpecification"
            | "SupplyDelivery"
            | "SupplyRequest"
            | "Task"
            | "TerminologyCapabilities"
            | "TestReport"
            | "TestScript"
            | "ValueSet"
            | "VerificationResult"
            | "VisionPrescription"
            | "AccessPolicyV2"
            | "ClientApplication"
            | "IdentityProvider"
            | "Membership"
            | "Project"
            | "User"
            | "AdministrableProductDefinition"
            | "Citation"
            | "ClinicalUseDefinition"
            | "EvidenceReport"
            | "Ingredient"
            | "ManufacturedItemDefinition"
            | "MedicinalProductDefinition"
            | "NutritionProduct"
            | "PackagedProductDefinition"
            | "RegulatedAuthorization"
            | "SubscriptionStatus"
            | "SubscriptionTopic"
            | "SubstanceDefinition",
>(
    ctx: CTX,
    fhirVersion: FHIRVersion,
    resourceType: T,
    id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>,
    versionId: NonNullable<
        Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"],
    >,
): Promise<Resource<FHIRVersion, T> | undefined>
Type Parameters
- FHIRVersion extends "4.0" | "4.3"
- T extends
      | "SearchParameter"
      | "Account"
      | "ActivityDefinition"
      | "AdverseEvent"
      | "AllergyIntolerance"
      | "Appointment"
      | "AppointmentResponse"
      | "AuditEvent"
      | "Basic"
      | "Binary"
      | "BiologicallyDerivedProduct"
      | "BodyStructure"
      | "Bundle"
      | "CapabilityStatement"
      | "CarePlan"
      | "CareTeam"
      | "CatalogEntry"
      | "ChargeItem"
      | "ChargeItemDefinition"
      | "Claim"
      | "ClaimResponse"
      | "ClinicalImpression"
      | "CodeSystem"
      | "Communication"
      | "CommunicationRequest"
      | "CompartmentDefinition"
      | "Composition"
      | "ConceptMap"
      | "Condition"
      | "Consent"
      | "Contract"
      | "Coverage"
      | "CoverageEligibilityRequest"
      | "CoverageEligibilityResponse"
      | "DetectedIssue"
      | "Device"
      | "DeviceDefinition"
      | "DeviceMetric"
      | "DeviceRequest"
      | "DeviceUseStatement"
      | "DiagnosticReport"
      | "DocumentManifest"
      | "DocumentReference"
      | "EffectEvidenceSynthesis"
      | "Encounter"
      | "Endpoint"
      | "EnrollmentRequest"
      | "EnrollmentResponse"
      | "EpisodeOfCare"
      | "EventDefinition"
      | "Evidence"
      | "EvidenceVariable"
      | "ExampleScenario"
      | "ExplanationOfBenefit"
      | "FamilyMemberHistory"
      | "Flag"
      | "Goal"
      | "GraphDefinition"
      | "Group"
      | "GuidanceResponse"
      | "HealthcareService"
      | "ImagingStudy"
      | "Immunization"
      | "ImmunizationEvaluation"
      | "ImmunizationRecommendation"
      | "ImplementationGuide"
      | "InsurancePlan"
      | "Invoice"
      | "Library"
      | "Linkage"
      | "List"
      | "Location"
      | "Measure"
      | "MeasureReport"
      | "Media"
      | "Medication"
      | "MedicationAdministration"
      | "MedicationDispense"
      | "MedicationKnowledge"
      | "MedicationRequest"
      | "MedicationStatement"
      | "MedicinalProduct"
      | "MedicinalProductAuthorization"
      | "MedicinalProductContraindication"
      | "MedicinalProductIndication"
      | "MedicinalProductIngredient"
      | "MedicinalProductInteraction"
      | "MedicinalProductManufactured"
      | "MedicinalProductPackaged"
      | "MedicinalProductPharmaceutical"
      | "MedicinalProductUndesirableEffect"
      | "MessageDefinition"
      | "MessageHeader"
      | "MolecularSequence"
      | "NamingSystem"
      | "NutritionOrder"
      | "Observation"
      | "ObservationDefinition"
      | "OperationDefinition"
      | "OperationOutcome"
      | "Organization"
      | "OrganizationAffiliation"
      | "Parameters"
      | "Patient"
      | "PaymentNotice"
      | "PaymentReconciliation"
      | "Person"
      | "PlanDefinition"
      | "Practitioner"
      | "PractitionerRole"
      | "Procedure"
      | "Provenance"
      | "Questionnaire"
      | "QuestionnaireResponse"
      | "RelatedPerson"
      | "RequestGroup"
      | "ResearchDefinition"
      | "ResearchElementDefinition"
      | "ResearchStudy"
      | "ResearchSubject"
      | "RiskAssessment"
      | "RiskEvidenceSynthesis"
      | "Schedule"
      | "ServiceRequest"
      | "Slot"
      | "Specimen"
      | "SpecimenDefinition"
      | "StructureDefinition"
      | "StructureMap"
      | "Subscription"
      | "Substance"
      | "SubstanceNucleicAcid"
      | "SubstancePolymer"
      | "SubstanceProtein"
      | "SubstanceReferenceInformation"
      | "SubstanceSourceMaterial"
      | "SubstanceSpecification"
      | "SupplyDelivery"
      | "SupplyRequest"
      | "Task"
      | "TerminologyCapabilities"
      | "TestReport"
      | "TestScript"
      | "ValueSet"
      | "VerificationResult"
      | "VisionPrescription"
      | "AccessPolicyV2"
      | "ClientApplication"
      | "IdentityProvider"
      | "Membership"
      | "Project"
      | "User"
      | "AdministrableProductDefinition"
      | "Citation"
      | "ClinicalUseDefinition"
      | "EvidenceReport"
      | "Ingredient"
      | "ManufacturedItemDefinition"
      | "MedicinalProductDefinition"
      | "NutritionProduct"
      | "PackagedProductDefinition"
      | "RegulatedAuthorization"
      | "SubscriptionStatus"
      | "SubscriptionTopic"
      | "SubstanceDefinition"
Parameters
- ctx: CTX
- fhirVersion: FHIRVersion
- resourceType: T
- id: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>
- versionId: NonNullable<Resource<FHIRVersion, ResourceType<FHIRVersion>>["id"]>
Returns Promise<Resource<FHIRVersion, T> | undefined>
Implementation of FHIRClientAsync.vread
- Defined in packages/client/src/index.ts:232

Class AsynchronousClient<CTX>

Type Parameters

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AsynchronousClient<CTX>

Accessors

middleware

Returns MiddlewareAsync<CTX>

Methods

batch

Type Parameters

Parameters

Returns Promise<Resource<FHIRVersion, "Bundle">>

capabilities

Type Parameters

Parameters

Returns Promise<Resource<FHIRVersion, "CapabilityStatement">>

conditionalUpdate

Type Parameters

Parameters

Returns Promise<Resource<FHIRVersion, T>>

create

Type Parameters

Parameters

Returns Promise<T>

delete_instance

Type Parameters

Parameters

Returns Promise<void>

delete_system

Type Parameters

Parameters

Returns Promise<void>

delete_type

Type Parameters

Parameters

Returns Promise<void>

history_instance

Type Parameters

Parameters

Returns Promise<NonNullable<Resource<FHIRVersion, "Bundle">["entry"]>>

history_system

Type Parameters

Parameters

Returns Promise<NonNullable<Resource<FHIRVersion, "Bundle">["entry"]>>

history_type

Type Parameters

Parameters

Returns Promise<NonNullable<Resource<FHIRVersion, "Bundle">["entry"]>>

invoke_instance

Type Parameters

Parameters

Returns Promise<Output>

invoke_system

Type Parameters

Parameters

Returns Promise<Output>

invoke_type

Type Parameters

Parameters

Returns Promise<Output>

patch

Type Parameters

Parameters

Returns Promise<Resource<FHIRVersion, T>>

read

Type Parameters

Parameters

Returns Promise<Resource<FHIRVersion, T> | undefined>

request

Type Parameters

Parameters

Returns Promise<FHIRResponse<Version, "error" | I>>

Returns Promise<
{
resources: Resource<FHIRVersion, ResourceType<FHIRVersion>>[];
total?: number;
},
>