Class AsynchronousClient<State, CTX>

Type Parameters

  • State
  • CTX

Implements

Constructors

constructor

Methods

batch capabilities conditionalUpdate create delete_instance delete_system delete_type history_instance history_system history_type invoke_instance invoke_system invoke_type patch read request search_system search_type transaction update vread

Constructors

constructor

Methods

batch

capabilities

conditionalUpdate

  • conditionalUpdate<FHIRVersion, T>(ctx, fhirVersion, resourceType, parameters, resource): 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"
          | "AccessPolicy"
          | "ClientApplication"
          | "IdentityProvider"
          | "Membership"
          | "MessageBroker"
          | "MessageTopic"
          | "AdministrableProductDefinition"
          | "Citation"
          | "ClinicalUseDefinition"
          | "EvidenceReport"
          | "Ingredient"
          | "ManufacturedItemDefinition"
          | "MedicinalProductDefinition"
          | "NutritionProduct"
          | "PackagedProductDefinition"
          | "RegulatedAuthorization"
          | "SubscriptionStatus"
          | "SubscriptionTopic"
          | "SubstanceDefinition"

    Parameters

    Returns Promise<Resource<FHIRVersion, T>>

create

delete_instance

  • delete_instance<FHIRVersion, T>(ctx, fhirVersion, resourceType, 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"
          | "AccessPolicy"
          | "ClientApplication"
          | "IdentityProvider"
          | "Membership"
          | "MessageBroker"
          | "MessageTopic"
          | "AdministrableProductDefinition"
          | "Citation"
          | "ClinicalUseDefinition"
          | "EvidenceReport"
          | "Ingredient"
          | "ManufacturedItemDefinition"
          | "MedicinalProductDefinition"
          | "NutritionProduct"
          | "PackagedProductDefinition"
          | "RegulatedAuthorization"
          | "SubscriptionStatus"
          | "SubscriptionTopic"
          | "SubstanceDefinition"

    Parameters

    Returns Promise<void>

delete_system

delete_type

  • delete_type<FHIRVersion, T>(ctx, fhirVersion, resourceType, parameters?): 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"
          | "AccessPolicy"
          | "ClientApplication"
          | "IdentityProvider"
          | "Membership"
          | "MessageBroker"
          | "MessageTopic"
          | "AdministrableProductDefinition"
          | "Citation"
          | "ClinicalUseDefinition"
          | "EvidenceReport"
          | "Ingredient"
          | "ManufacturedItemDefinition"
          | "MedicinalProductDefinition"
          | "NutritionProduct"
          | "PackagedProductDefinition"
          | "RegulatedAuthorization"
          | "SubscriptionStatus"
          | "SubscriptionTopic"
          | "SubstanceDefinition"

    Parameters

    Returns Promise<void>

history_instance

  • history_instance<FHIRVersion, T>(ctx, fhirVersion, resourceType, id, parameters?): 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"
          | "AccessPolicy"
          | "ClientApplication"
          | "IdentityProvider"
          | "Membership"
          | "MessageBroker"
          | "MessageTopic"
          | "AdministrableProductDefinition"
          | "Citation"
          | "ClinicalUseDefinition"
          | "EvidenceReport"
          | "Ingredient"
          | "ManufacturedItemDefinition"
          | "MedicinalProductDefinition"
          | "NutritionProduct"
          | "PackagedProductDefinition"
          | "RegulatedAuthorization"
          | "SubscriptionStatus"
          | "SubscriptionTopic"
          | "SubstanceDefinition"

    Parameters

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

history_system

history_type

  • history_type<FHIRVersion, T>(ctx, fhirVersion, resourceType, parameters?): 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"
          | "AccessPolicy"
          | "ClientApplication"
          | "IdentityProvider"
          | "Membership"
          | "MessageBroker"
          | "MessageTopic"
          | "AdministrableProductDefinition"
          | "Citation"
          | "ClinicalUseDefinition"
          | "EvidenceReport"
          | "Ingredient"
          | "ManufacturedItemDefinition"
          | "MedicinalProductDefinition"
          | "NutritionProduct"
          | "PackagedProductDefinition"
          | "RegulatedAuthorization"
          | "SubscriptionStatus"
          | "SubscriptionTopic"
          | "SubstanceDefinition"

    Parameters

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

invoke_instance

  • invoke_instance<FHIRVersion, Op, Input, Output, T>(op, ctx, fhirVersion, resourceType, id, 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"
          | "AccessPolicy"
          | "ClientApplication"
          | "IdentityProvider"
          | "Membership"
          | "MessageBroker"
          | "MessageTopic"
          | "AdministrableProductDefinition"
          | "Citation"
          | "ClinicalUseDefinition"
          | "EvidenceReport"
          | "Ingredient"
          | "ManufacturedItemDefinition"
          | "MedicinalProductDefinition"
          | "NutritionProduct"
          | "PackagedProductDefinition"
          | "RegulatedAuthorization"
          | "SubscriptionStatus"
          | "SubscriptionTopic"
          | "SubstanceDefinition"

    Parameters

    Returns Promise<Output>

invoke_system

invoke_type

  • invoke_type<FHIRVersion, Op, Input, Output, T>(op, ctx, fhirVersion, resourceType, 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"
          | "AccessPolicy"
          | "ClientApplication"
          | "IdentityProvider"
          | "Membership"
          | "MessageBroker"
          | "MessageTopic"
          | "AdministrableProductDefinition"
          | "Citation"
          | "ClinicalUseDefinition"
          | "EvidenceReport"
          | "Ingredient"
          | "ManufacturedItemDefinition"
          | "MedicinalProductDefinition"
          | "NutritionProduct"
          | "PackagedProductDefinition"
          | "RegulatedAuthorization"
          | "SubscriptionStatus"
          | "SubscriptionTopic"
          | "SubstanceDefinition"

    Parameters

    Returns Promise<Output>

patch

  • patch<FHIRVersion, T>(ctx, fhirVersion, resourceType, id, patches): 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"
          | "AccessPolicy"
          | "ClientApplication"
          | "IdentityProvider"
          | "Membership"
          | "MessageBroker"
          | "MessageTopic"
          | "AdministrableProductDefinition"
          | "Citation"
          | "ClinicalUseDefinition"
          | "EvidenceReport"
          | "Ingredient"
          | "ManufacturedItemDefinition"
          | "MedicinalProductDefinition"
          | "NutritionProduct"
          | "PackagedProductDefinition"
          | "RegulatedAuthorization"
          | "SubscriptionStatus"
          | "SubscriptionTopic"
          | "SubstanceDefinition"

    Parameters

    Returns Promise<Resource<FHIRVersion, T>>

read

  • read<FHIRVersion, T>(ctx, fhirVersion, resourceType, id): Promise<undefined | 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"
          | "AccessPolicy"
          | "ClientApplication"
          | "IdentityProvider"
          | "Membership"
          | "MessageBroker"
          | "MessageTopic"
          | "AdministrableProductDefinition"
          | "Citation"
          | "ClinicalUseDefinition"
          | "EvidenceReport"
          | "Ingredient"
          | "ManufacturedItemDefinition"
          | "MedicinalProductDefinition"
          | "NutritionProduct"
          | "PackagedProductDefinition"
          | "RegulatedAuthorization"
          | "SubscriptionStatus"
          | "SubscriptionTopic"
          | "SubstanceDefinition"

    Parameters

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

request

search_system

search_type

  • search_type<Version, T>(ctx, fhirVersion, type, parameters): 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"
          | "AccessPolicy"
          | "ClientApplication"
          | "IdentityProvider"
          | "Membership"
          | "MessageBroker"
          | "MessageTopic"
          | "AdministrableProductDefinition"
          | "Citation"
          | "ClinicalUseDefinition"
          | "EvidenceReport"
          | "Ingredient"
          | "ManufacturedItemDefinition"
          | "MedicinalProductDefinition"
          | "NutritionProduct"
          | "PackagedProductDefinition"
          | "RegulatedAuthorization"
          | "SubscriptionStatus"
          | "SubscriptionTopic"
          | "SubstanceDefinition"

    Parameters

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

transaction

update

  • update<FHIRVersion, T>(ctx, fhirVersion, resourceType, id, resource): 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"
          | "AccessPolicy"
          | "ClientApplication"
          | "IdentityProvider"
          | "Membership"
          | "MessageBroker"
          | "MessageTopic"
          | "AdministrableProductDefinition"
          | "Citation"
          | "ClinicalUseDefinition"
          | "EvidenceReport"
          | "Ingredient"
          | "ManufacturedItemDefinition"
          | "MedicinalProductDefinition"
          | "NutritionProduct"
          | "PackagedProductDefinition"
          | "RegulatedAuthorization"
          | "SubscriptionStatus"
          | "SubscriptionTopic"
          | "SubstanceDefinition"

    Parameters

    Returns Promise<Resource<FHIRVersion, T>>

vread

  • vread<FHIRVersion, T>(ctx, fhirVersion, resourceType, id, versionId): Promise<undefined | 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"
          | "AccessPolicy"
          | "ClientApplication"
          | "IdentityProvider"
          | "Membership"
          | "MessageBroker"
          | "MessageTopic"
          | "AdministrableProductDefinition"
          | "Citation"
          | "ClinicalUseDefinition"
          | "EvidenceReport"
          | "Ingredient"
          | "ManufacturedItemDefinition"
          | "MedicinalProductDefinition"
          | "NutritionProduct"
          | "PackagedProductDefinition"
          | "RegulatedAuthorization"
          | "SubscriptionStatus"
          | "SubscriptionTopic"
          | "SubstanceDefinition"

    Parameters

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

Settings

Member Visibility

On This Page

Constructors
Methods