fhir_r5_at_rest library

Classes

FhirBatchRequest
  • Batch Request (POST)
    • FhirCapabilitiesRequest
  • Capabilities Request (GET)
    • FhirCreateRequest
  • Create Request (POST)
    • FhirDeleteRequest
  • Delete Request (DELETE)
    • FhirHistoryAllRequest
  • History All (GET)
    • FhirHistoryRequest
  • History Request (GET)
    • FhirOperationRequest
  • Operation Request (POST or GET)
    • FhirPatchRequest
  • Patch Request (PATCH)
    • FhirReadRequest
  • Read Request (GET)
    • FhirRequest
    Enum to represent the summary parameter
    FhirSearchRequest
  • Search Request (GET or POST)
    • FhirTransactionRequest
  • Transaction Request (POST)
    • FhirUpdateRequest
  • Update Request (PUT)
    • FhirVReadRequest
  • vRead Request (GET specific version)
    • PatchBody
    Utility class for building a JSON Patch or FHIR Patch body
    RestfulParameters
    A class to build query parameters for RESTful requests.
    ReturnResults<T>
    A class to hold the results of a RESTful operation.
    SearchAccount
    A class to build query parameters for RESTful requests for the Account resource.
    SearchActivityDefinition
    A class to build query parameters for RESTful requests for the ActivityDefinition resource.
    SearchActorDefinition
    A class to build query parameters for RESTful requests for the ActorDefinition resource.
    SearchAdministrableProductDefinition
    A class to build query parameters for RESTful requests for the AdministrableProductDefinition resource.
    SearchAdverseEvent
    A class to build query parameters for RESTful requests for the AdverseEvent resource.
    SearchAllergyIntolerance
    A class to build query parameters for RESTful requests for the AllergyIntolerance resource.
    SearchAppointment
    A class to build query parameters for RESTful requests for the Appointment resource.
    SearchAppointmentResponse
    A class to build query parameters for RESTful requests for the AppointmentResponse resource.
    SearchArtifactAssessment
    A class to build query parameters for RESTful requests for the ArtifactAssessment resource.
    SearchAuditEvent
    A class to build query parameters for RESTful requests for the AuditEvent resource.
    SearchBasic
    A class to build query parameters for RESTful requests for the Basic resource.
    SearchBiologicallyDerivedProduct
    A class to build query parameters for RESTful requests for the BiologicallyDerivedProduct resource.
    SearchBiologicallyDerivedProductDispense
    A class to build query parameters for RESTful requests for the BiologicallyDerivedProductDispense resource.
    SearchBodyStructure
    A class to build query parameters for RESTful requests for the BodyStructure resource.
    SearchBundle
    A class to build query parameters for RESTful requests for the Bundle resource.
    SearchCapabilityStatement
    A class to build query parameters for RESTful requests for the CapabilityStatement resource.
    SearchCarePlan
    A class to build query parameters for RESTful requests for the CarePlan resource.
    SearchCareTeam
    A class to build query parameters for RESTful requests for the CareTeam resource.
    SearchChargeItem
    A class to build query parameters for RESTful requests for the ChargeItem resource.
    SearchChargeItemDefinition
    A class to build query parameters for RESTful requests for the ChargeItemDefinition resource.
    SearchCitation
    A class to build query parameters for RESTful requests for the Citation resource.
    SearchClaim
    A class to build query parameters for RESTful requests for the Claim resource.
    SearchClaimResponse
    A class to build query parameters for RESTful requests for the ClaimResponse resource.
    SearchClinicalImpression
    A class to build query parameters for RESTful requests for the ClinicalImpression resource.
    SearchClinicalUseDefinition
    A class to build query parameters for RESTful requests for the ClinicalUseDefinition resource.
    SearchCodeSystem
    A class to build query parameters for RESTful requests for the CodeSystem resource.
    SearchCommunication
    A class to build query parameters for RESTful requests for the Communication resource.
    SearchCommunicationRequest
    A class to build query parameters for RESTful requests for the CommunicationRequest resource.
    SearchCompartmentDefinition
    A class to build query parameters for RESTful requests for the CompartmentDefinition resource.
    SearchComposition
    A class to build query parameters for RESTful requests for the Composition resource.
    SearchConceptMap
    A class to build query parameters for RESTful requests for the ConceptMap resource.
    SearchCondition
    A class to build query parameters for RESTful requests for the Condition resource.
    SearchConditionDefinition
    A class to build query parameters for RESTful requests for the ConditionDefinition resource.
    SearchConsent
    A class to build query parameters for RESTful requests for the Consent resource.
    SearchContract
    A class to build query parameters for RESTful requests for the Contract resource.
    SearchCoverage
    A class to build query parameters for RESTful requests for the Coverage resource.
    SearchCoverageEligibilityRequest
    A class to build query parameters for RESTful requests for the CoverageEligibilityRequest resource.
    SearchCoverageEligibilityResponse
    A class to build query parameters for RESTful requests for the CoverageEligibilityResponse resource.
    SearchDetectedIssue
    A class to build query parameters for RESTful requests for the DetectedIssue resource.
    SearchDevice
    A class to build query parameters for RESTful requests for the Device resource.
    SearchDeviceAssociation
    A class to build query parameters for RESTful requests for the DeviceAssociation resource.
    SearchDeviceDefinition
    A class to build query parameters for RESTful requests for the DeviceDefinition resource.
    SearchDeviceDispense
    A class to build query parameters for RESTful requests for the DeviceDispense resource.
    SearchDeviceMetric
    A class to build query parameters for RESTful requests for the DeviceMetric resource.
    SearchDeviceRequest
    A class to build query parameters for RESTful requests for the DeviceRequest resource.
    SearchDeviceUsage
    A class to build query parameters for RESTful requests for the DeviceUsage resource.
    SearchDiagnosticReport
    A class to build query parameters for RESTful requests for the DiagnosticReport resource.
    SearchDocumentReference
    A class to build query parameters for RESTful requests for the DocumentReference resource.
    SearchEncounter
    A class to build query parameters for RESTful requests for the Encounter resource.
    SearchEncounterHistory
    A class to build query parameters for RESTful requests for the EncounterHistory resource.
    SearchEndpoint
    A class to build query parameters for RESTful requests for the Endpoint resource.
    SearchEnrollmentRequest
    A class to build query parameters for RESTful requests for the EnrollmentRequest resource.
    SearchEnrollmentResponse
    A class to build query parameters for RESTful requests for the EnrollmentResponse resource.
    SearchEpisodeOfCare
    A class to build query parameters for RESTful requests for the EpisodeOfCare resource.
    SearchEventDefinition
    A class to build query parameters for RESTful requests for the EventDefinition resource.
    SearchEvidence
    A class to build query parameters for RESTful requests for the Evidence resource.
    SearchEvidenceReport
    A class to build query parameters for RESTful requests for the EvidenceReport resource.
    SearchEvidenceVariable
    A class to build query parameters for RESTful requests for the EvidenceVariable resource.
    SearchExampleScenario
    A class to build query parameters for RESTful requests for the ExampleScenario resource.
    SearchExplanationOfBenefit
    A class to build query parameters for RESTful requests for the ExplanationOfBenefit resource.
    SearchFamilyMemberHistory
    A class to build query parameters for RESTful requests for the FamilyMemberHistory resource.
    SearchFlag
    A class to build query parameters for RESTful requests for the Flag resource.
    SearchFormularyItem
    A class to build query parameters for RESTful requests for the FormularyItem resource.
    SearchGenomicStudy
    A class to build query parameters for RESTful requests for the GenomicStudy resource.
    SearchGoal
    A class to build query parameters for RESTful requests for the Goal resource.
    SearchGraphDefinition
    A class to build query parameters for RESTful requests for the GraphDefinition resource.
    SearchGroup
    A class to build query parameters for RESTful requests for the Group resource.
    SearchGuidanceResponse
    A class to build query parameters for RESTful requests for the GuidanceResponse resource.
    SearchHealthcareService
    A class to build query parameters for RESTful requests for the HealthcareService resource.
    SearchImagingSelection
    A class to build query parameters for RESTful requests for the ImagingSelection resource.
    SearchImagingStudy
    A class to build query parameters for RESTful requests for the ImagingStudy resource.
    SearchImmunization
    A class to build query parameters for RESTful requests for the Immunization resource.
    SearchImmunizationEvaluation
    A class to build query parameters for RESTful requests for the ImmunizationEvaluation resource.
    SearchImmunizationRecommendation
    A class to build query parameters for RESTful requests for the ImmunizationRecommendation resource.
    SearchImplementationGuide
    A class to build query parameters for RESTful requests for the ImplementationGuide resource.
    SearchIngredient
    A class to build query parameters for RESTful requests for the Ingredient resource.
    SearchInsurancePlan
    A class to build query parameters for RESTful requests for the InsurancePlan resource.
    SearchInventoryItem
    A class to build query parameters for RESTful requests for the InventoryItem resource.
    SearchInventoryReport
    A class to build query parameters for RESTful requests for the InventoryReport resource.
    SearchInvoice
    A class to build query parameters for RESTful requests for the Invoice resource.
    SearchLibrary
    A class to build query parameters for RESTful requests for the Library resource.
    SearchLinkage
    A class to build query parameters for RESTful requests for the Linkage resource.
    SearchList
    A class to build query parameters for RESTful requests for the List resource.
    SearchLocation
    A class to build query parameters for RESTful requests for the Location resource.
    SearchManufacturedItemDefinition
    A class to build query parameters for RESTful requests for the ManufacturedItemDefinition resource.
    SearchMeasure
    A class to build query parameters for RESTful requests for the Measure resource.
    SearchMeasureReport
    A class to build query parameters for RESTful requests for the MeasureReport resource.
    SearchMedication
    A class to build query parameters for RESTful requests for the Medication resource.
    SearchMedicationAdministration
    A class to build query parameters for RESTful requests for the MedicationAdministration resource.
    SearchMedicationDispense
    A class to build query parameters for RESTful requests for the MedicationDispense resource.
    SearchMedicationKnowledge
    A class to build query parameters for RESTful requests for the MedicationKnowledge resource.
    SearchMedicationRequest
    A class to build query parameters for RESTful requests for the MedicationRequest resource.
    SearchMedicationStatement
    A class to build query parameters for RESTful requests for the MedicationStatement resource.
    SearchMedicinalProductDefinition
    A class to build query parameters for RESTful requests for the MedicinalProductDefinition resource.
    SearchMessageDefinition
    A class to build query parameters for RESTful requests for the MessageDefinition resource.
    SearchMessageHeader
    A class to build query parameters for RESTful requests for the MessageHeader resource.
    SearchMolecularSequence
    A class to build query parameters for RESTful requests for the MolecularSequence resource.
    SearchNamingSystem
    A class to build query parameters for RESTful requests for the NamingSystem resource.
    SearchNutritionIntake
    A class to build query parameters for RESTful requests for the NutritionIntake resource.
    SearchNutritionOrder
    A class to build query parameters for RESTful requests for the NutritionOrder resource.
    SearchNutritionProduct
    A class to build query parameters for RESTful requests for the NutritionProduct resource.
    SearchObservation
    A class to build query parameters for RESTful requests for the Observation resource.
    SearchObservationDefinition
    A class to build query parameters for RESTful requests for the ObservationDefinition resource.
    SearchOperationDefinition
    A class to build query parameters for RESTful requests for the OperationDefinition resource.
    SearchOrganization
    A class to build query parameters for RESTful requests for the Organization resource.
    SearchOrganizationAffiliation
    A class to build query parameters for RESTful requests for the OrganizationAffiliation resource.
    SearchPackagedProductDefinition
    A class to build query parameters for RESTful requests for the PackagedProductDefinition resource.
    SearchPatient
    A class to build query parameters for RESTful requests for the Patient resource.
    SearchPaymentNotice
    A class to build query parameters for RESTful requests for the PaymentNotice resource.
    SearchPaymentReconciliation
    A class to build query parameters for RESTful requests for the PaymentReconciliation resource.
    SearchPermission
    A class to build query parameters for RESTful requests for the Permission resource.
    SearchPerson
    A class to build query parameters for RESTful requests for the Person resource.
    SearchPlanDefinition
    A class to build query parameters for RESTful requests for the PlanDefinition resource.
    SearchPractitioner
    A class to build query parameters for RESTful requests for the Practitioner resource.
    SearchPractitionerRole
    A class to build query parameters for RESTful requests for the PractitionerRole resource.
    SearchProcedure
    A class to build query parameters for RESTful requests for the Procedure resource.
    SearchProvenance
    A class to build query parameters for RESTful requests for the Provenance resource.
    SearchQuestionnaire
    A class to build query parameters for RESTful requests for the Questionnaire resource.
    SearchQuestionnaireResponse
    A class to build query parameters for RESTful requests for the QuestionnaireResponse resource.
    SearchRegulatedAuthorization
    A class to build query parameters for RESTful requests for the RegulatedAuthorization resource.
    SearchRelatedPerson
    A class to build query parameters for RESTful requests for the RelatedPerson resource.
    SearchRequestOrchestration
    A class to build query parameters for RESTful requests for the RequestOrchestration resource.
    SearchRequirements
    A class to build query parameters for RESTful requests for the Requirements resource.
    SearchResearchStudy
    A class to build query parameters for RESTful requests for the ResearchStudy resource.
    SearchResearchSubject
    A class to build query parameters for RESTful requests for the ResearchSubject resource.
    SearchResource
    A class to build query parameters for RESTful requests for the Resource resource.
    SearchRiskAssessment
    A class to build query parameters for RESTful requests for the RiskAssessment resource.
    SearchSchedule
    A class to build query parameters for RESTful requests for the Schedule resource.
    SearchSearchParameter
    A class to build query parameters for RESTful requests for the SearchParameter resource.
    SearchServiceRequest
    A class to build query parameters for RESTful requests for the ServiceRequest resource.
    SearchSlot
    A class to build query parameters for RESTful requests for the Slot resource.
    SearchSpecimen
    A class to build query parameters for RESTful requests for the Specimen resource.
    SearchSpecimenDefinition
    A class to build query parameters for RESTful requests for the SpecimenDefinition resource.
    SearchStructureDefinition
    A class to build query parameters for RESTful requests for the StructureDefinition resource.
    SearchStructureMap
    A class to build query parameters for RESTful requests for the StructureMap resource.
    SearchSubscription
    A class to build query parameters for RESTful requests for the Subscription resource.
    SearchSubscriptionTopic
    A class to build query parameters for RESTful requests for the SubscriptionTopic resource.
    SearchSubstance
    A class to build query parameters for RESTful requests for the Substance resource.
    SearchSubstanceDefinition
    A class to build query parameters for RESTful requests for the SubstanceDefinition resource.
    SearchSupplyDelivery
    A class to build query parameters for RESTful requests for the SupplyDelivery resource.
    SearchSupplyRequest
    A class to build query parameters for RESTful requests for the SupplyRequest resource.
    SearchTask
    A class to build query parameters for RESTful requests for the Task resource.
    SearchTerminologyCapabilities
    A class to build query parameters for RESTful requests for the TerminologyCapabilities resource.
    SearchTestPlan
    A class to build query parameters for RESTful requests for the TestPlan resource.
    SearchTestReport
    A class to build query parameters for RESTful requests for the TestReport resource.
    SearchTestScript
    A class to build query parameters for RESTful requests for the TestScript resource.
    SearchTransport
    A class to build query parameters for RESTful requests for the Transport resource.
    SearchValueSet
    A class to build query parameters for RESTful requests for the ValueSet resource.
    SearchVerificationResult
    A class to build query parameters for RESTful requests for the VerificationResult resource.
    SearchVisionPrescription
    A class to build query parameters for RESTful requests for the VisionPrescription resource.

    Enums

    Mode
    MODE Enum Defines the capabilities of the server https://www.hl7.org/fhir/http.html#capabilities
    PatchOps
    Enum for JSON Patch and FHIR Patch operations
    SearchModifier
    Define an enum for search modifiers
    Summary
    SUMMARY Enum The client can request the server to return only a portion of the resources by using this parameter Defined here: https://www.hl7.org/fhir/search.html#summary

    Functions

    incorrectResultType<T>(Resource result) → OperationOutcome
    Returns an OperationOutcome that contains the given Resource and a message stating that it was not the type of resource that was specified
    isInformational(OperationOutcome operationOutcome) → bool
    Returns true if the OperationOutcome is informational
    parseBundle(Bundle bundle) → ReturnResults<Resource>
    Extracts all Resources that were returned by the Bundle, as long as they aren't OperationOutcomes, and includes all entries as informational OperationOutcomes that don't contain a Resource
    parseBundleForType<T>(Bundle bundle) → ReturnResults<T>
    Extracts all Resources that were returned by the Bundle as long as they are of type T
    parseRequestResult(Resource result) → ReturnResults<Resource>
    There are usually 3 types of responses from a RESTful request made to a FHIR server. It can be a single Resource, it can be a Bundle, or it can be an OperationOutcome (usually indicating an error). The functions below return an object called ReturnResults. It contains 3 lists.
    parseRequestResultForType<T>(Resource result) → ReturnResults<T>
    If you searched or requested only a specific type of result, this will perform similarly to above, but will return ONLY that type of resource in the resources field, others will be included in the otherResources as well as in an OperationOutcome as a contained resource