MEmedplum

Search

Changed on

Search

get/fhir/R4/{resourceType}

Request

  • Base URL
    https://api.medplum.com
  • URL
    https://api.medplum.com/fhir/R4/{resourceType}
  • Auth
    • HTTP basic
    • or HTTP bearer
    • or OpenID Connect (https://api.medplum.com/.well-known/openid-configuration)
    • or OAuth 2
      Authorization code: https://api.medplum.com/oauth2/authorize
      Client credentials
      Token URL: https://api.medplum.com/oauth2/token

Path parameters

resourceType'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' | 'SearchParameter' | 'ServiceRequest' | 'Slot' | 'Specimen' | 'SpecimenDefinition' | 'StructureDefinition' | 'StructureMap' | 'Subscription' | 'Substance' | 'SubstanceNucleicAcid' | 'SubstancePolymer' | 'SubstanceProtein' | 'SubstanceReferenceInformation' | 'SubstanceSourceMaterial' | 'SubstanceSpecification' | 'SupplyDelivery' | 'SupplyRequest' | 'Task' | 'TerminologyCapabilities' | 'TestReport' | 'TestScript' | 'ValueSet' | 'VerificationResult' | 'VisionPrescription' | 'Project' | 'ProjectMembership' | 'ClientApplication' | 'User' | 'Login' | 'JsonWebKey' | 'Bot' | 'AccessPolicy' | 'UserConfiguration' | 'BulkDataExport' | 'SmartAppLaunch' | 'DomainConfiguration' | 'AsyncJob' | 'Agent' | 'UserSecurityRequest' | 'Package' | 'PackageRelease' | 'PackageInstallation' | 'SmartHealthLink' | 'DicomStudy' | 'DicomSeries' | 'DicomInstance' | 'Enterprise' | 'Cron' required

Resource Type

Query parameters

criteriaobject

FHIR search parameters, such as identifier=http://example.com|123

Response

Success

resourceTypestring required

This is a Bundle resource

idstring

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

implicitRulesstring

String of characters used to identify a name or a resource

languagestring

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

type'document' | 'message' | 'transaction' | 'transaction-response' | 'batch' | 'batch-response' | 'history' | 'searchset' | 'collection'

Indicates the purpose of this bundle - how it is intended to be used.

timestampstring

An instant in time - known at least to the second

totalnumber

An integer with a value that is not negative (e.g. >= 0)

Changes

  • 2ee112db7111Revision changes
    • breaking

      the path request parameter resourceType was restricted to a list of enum values

    • info

      added the new optional query request parameter criteria

    • info

      added the new enum value AccessPolicy to the path request parameter resourceType

    • info

      added the new enum value Account to the path request parameter resourceType

    • info

      added the new enum value ActivityDefinition to the path request parameter resourceType

    • info

      added the new enum value AdverseEvent to the path request parameter resourceType

    • info

      added the new enum value Agent to the path request parameter resourceType

    • info

      added the new enum value AllergyIntolerance to the path request parameter resourceType

    • info

      added the new enum value Appointment to the path request parameter resourceType

    • info

      added the new enum value AppointmentResponse to the path request parameter resourceType

    • info

      added the new enum value AsyncJob to the path request parameter resourceType

    • info

      added the new enum value AuditEvent to the path request parameter resourceType

    • info

      added the new enum value Basic to the path request parameter resourceType

    • info

      added the new enum value Binary to the path request parameter resourceType

    • info

      added the new enum value BiologicallyDerivedProduct to the path request parameter resourceType

    • info

      added the new enum value BodyStructure to the path request parameter resourceType

    • info

      added the new enum value Bot to the path request parameter resourceType

    • info

      added the new enum value BulkDataExport to the path request parameter resourceType

    • info

      added the new enum value Bundle to the path request parameter resourceType

    • info

      added the new enum value CapabilityStatement to the path request parameter resourceType

    • info

      added the new enum value CarePlan to the path request parameter resourceType

    • info

      added the new enum value CareTeam to the path request parameter resourceType

    • info

      added the new enum value CatalogEntry to the path request parameter resourceType

    • info

      added the new enum value ChargeItem to the path request parameter resourceType

    • info

      added the new enum value ChargeItemDefinition to the path request parameter resourceType

    • info

      added the new enum value Claim to the path request parameter resourceType

    • info

      added the new enum value ClaimResponse to the path request parameter resourceType

    • info

      added the new enum value ClientApplication to the path request parameter resourceType

    • info

      added the new enum value ClinicalImpression to the path request parameter resourceType

    • info

      added the new enum value CodeSystem to the path request parameter resourceType

    • info

      added the new enum value Communication to the path request parameter resourceType

    • info

      added the new enum value CommunicationRequest to the path request parameter resourceType

    • info

      added the new enum value CompartmentDefinition to the path request parameter resourceType

    • info

      added the new enum value Composition to the path request parameter resourceType

    • info

      added the new enum value ConceptMap to the path request parameter resourceType

    • info

      added the new enum value Condition to the path request parameter resourceType

    • info

      added the new enum value Consent to the path request parameter resourceType

    • info

      added the new enum value Contract to the path request parameter resourceType

    • info

      added the new enum value Coverage to the path request parameter resourceType

    • info

      added the new enum value CoverageEligibilityRequest to the path request parameter resourceType

    • info

      added the new enum value CoverageEligibilityResponse to the path request parameter resourceType

    • info

      added the new enum value Cron to the path request parameter resourceType

    • info

      added the new enum value DetectedIssue to the path request parameter resourceType

    • info

      added the new enum value Device to the path request parameter resourceType

    • info

      added the new enum value DeviceDefinition to the path request parameter resourceType

    • info

      added the new enum value DeviceMetric to the path request parameter resourceType

    • info

      added the new enum value DeviceRequest to the path request parameter resourceType

    • info

      added the new enum value DeviceUseStatement to the path request parameter resourceType

    • info

      added the new enum value DiagnosticReport to the path request parameter resourceType

    • info

      added the new enum value DicomInstance to the path request parameter resourceType

    • info

      added the new enum value DicomSeries to the path request parameter resourceType

    • info

      added the new enum value DicomStudy to the path request parameter resourceType

    • info

      added the new enum value DocumentManifest to the path request parameter resourceType

    • info

      added the new enum value DocumentReference to the path request parameter resourceType

    • info

      added the new enum value DomainConfiguration to the path request parameter resourceType

    • info

      added the new enum value EffectEvidenceSynthesis to the path request parameter resourceType

    • info

      added the new enum value Encounter to the path request parameter resourceType

    • info

      added the new enum value Endpoint to the path request parameter resourceType

    • info

      added the new enum value EnrollmentRequest to the path request parameter resourceType

    • info

      added the new enum value EnrollmentResponse to the path request parameter resourceType

    • info

      added the new enum value Enterprise to the path request parameter resourceType

    • info

      added the new enum value EpisodeOfCare to the path request parameter resourceType

    • info

      added the new enum value EventDefinition to the path request parameter resourceType

    • info

      added the new enum value Evidence to the path request parameter resourceType

    • info

      added the new enum value EvidenceVariable to the path request parameter resourceType

    • info

      added the new enum value ExampleScenario to the path request parameter resourceType

    • info

      added the new enum value ExplanationOfBenefit to the path request parameter resourceType

    • info

      added the new enum value FamilyMemberHistory to the path request parameter resourceType

    • info

      added the new enum value Flag to the path request parameter resourceType

    • info

      added the new enum value Goal to the path request parameter resourceType

    • info

      added the new enum value GraphDefinition to the path request parameter resourceType

    • info

      added the new enum value Group to the path request parameter resourceType

    • info

      added the new enum value GuidanceResponse to the path request parameter resourceType

    • info

      added the new enum value HealthcareService to the path request parameter resourceType

    • info

      added the new enum value ImagingStudy to the path request parameter resourceType

    • info

      added the new enum value Immunization to the path request parameter resourceType

    • info

      added the new enum value ImmunizationEvaluation to the path request parameter resourceType

    • info

      added the new enum value ImmunizationRecommendation to the path request parameter resourceType

    • info

      added the new enum value ImplementationGuide to the path request parameter resourceType

    • info

      added the new enum value InsurancePlan to the path request parameter resourceType

    • info

      added the new enum value Invoice to the path request parameter resourceType

    • info

      added the new enum value JsonWebKey to the path request parameter resourceType

    • info

      added the new enum value Library to the path request parameter resourceType

    • info

      added the new enum value Linkage to the path request parameter resourceType

    • info

      added the new enum value List to the path request parameter resourceType

    • info

      added the new enum value Location to the path request parameter resourceType

    • info

      added the new enum value Login to the path request parameter resourceType

    • info

      added the new enum value Measure to the path request parameter resourceType

    • info

      added the new enum value MeasureReport to the path request parameter resourceType

    • info

      added the new enum value Media to the path request parameter resourceType

    • info

      added the new enum value Medication to the path request parameter resourceType

    • info

      added the new enum value MedicationAdministration to the path request parameter resourceType

    • info

      added the new enum value MedicationDispense to the path request parameter resourceType

    • info

      added the new enum value MedicationKnowledge to the path request parameter resourceType

    • info

      added the new enum value MedicationRequest to the path request parameter resourceType

    • info

      added the new enum value MedicationStatement to the path request parameter resourceType

    • info

      added the new enum value MedicinalProduct to the path request parameter resourceType

    • info

      added the new enum value MedicinalProductAuthorization to the path request parameter resourceType

    • info

      added the new enum value MedicinalProductContraindication to the path request parameter resourceType

    • info

      added the new enum value MedicinalProductIndication to the path request parameter resourceType

    • info

      added the new enum value MedicinalProductIngredient to the path request parameter resourceType

    • info

      added the new enum value MedicinalProductInteraction to the path request parameter resourceType

    • info

      added the new enum value MedicinalProductManufactured to the path request parameter resourceType

    • info

      added the new enum value MedicinalProductPackaged to the path request parameter resourceType

    • info

      added the new enum value MedicinalProductPharmaceutical to the path request parameter resourceType

    • info

      added the new enum value MedicinalProductUndesirableEffect to the path request parameter resourceType

    • info

      added the new enum value MessageDefinition to the path request parameter resourceType

    • info

      added the new enum value MessageHeader to the path request parameter resourceType

    • info

      added the new enum value MolecularSequence to the path request parameter resourceType

    • info

      added the new enum value NamingSystem to the path request parameter resourceType

    • info

      added the new enum value NutritionOrder to the path request parameter resourceType

    • info

      added the new enum value Observation to the path request parameter resourceType

    • info

      added the new enum value ObservationDefinition to the path request parameter resourceType

    • info

      added the new enum value OperationDefinition to the path request parameter resourceType

    • info

      added the new enum value OperationOutcome to the path request parameter resourceType

    • info

      added the new enum value Organization to the path request parameter resourceType

    • info

      added the new enum value OrganizationAffiliation to the path request parameter resourceType

    • info

      added the new enum value Package to the path request parameter resourceType

    • info

      added the new enum value PackageInstallation to the path request parameter resourceType

    • info

      added the new enum value PackageRelease to the path request parameter resourceType

    • info

      added the new enum value Parameters to the path request parameter resourceType

    • info

      added the new enum value Patient to the path request parameter resourceType

    • info

      added the new enum value PaymentNotice to the path request parameter resourceType

    • info

      added the new enum value PaymentReconciliation to the path request parameter resourceType

    • info

      added the new enum value Person to the path request parameter resourceType

    • info

      added the new enum value PlanDefinition to the path request parameter resourceType

    • info

      added the new enum value Practitioner to the path request parameter resourceType

    • info

      added the new enum value PractitionerRole to the path request parameter resourceType

    • info

      added the new enum value Procedure to the path request parameter resourceType

    • info

      added the new enum value Project to the path request parameter resourceType

    • info

      added the new enum value ProjectMembership to the path request parameter resourceType

    • info

      added the new enum value Provenance to the path request parameter resourceType

    • info

      added the new enum value Questionnaire to the path request parameter resourceType

    • info

      added the new enum value QuestionnaireResponse to the path request parameter resourceType

    • info

      added the new enum value RelatedPerson to the path request parameter resourceType

    • info

      added the new enum value RequestGroup to the path request parameter resourceType

    • info

      added the new enum value ResearchDefinition to the path request parameter resourceType

    • info

      added the new enum value ResearchElementDefinition to the path request parameter resourceType

    • info

      added the new enum value ResearchStudy to the path request parameter resourceType

    • info

      added the new enum value ResearchSubject to the path request parameter resourceType

    • info

      added the new enum value RiskAssessment to the path request parameter resourceType

    • info

      added the new enum value RiskEvidenceSynthesis to the path request parameter resourceType

    • info

      added the new enum value Schedule to the path request parameter resourceType

    • info

      added the new enum value SearchParameter to the path request parameter resourceType

    • info

      added the new enum value ServiceRequest to the path request parameter resourceType

    • info

      added the new enum value Slot to the path request parameter resourceType

    • info

      added the new enum value SmartAppLaunch to the path request parameter resourceType

    • info

      added the new enum value SmartHealthLink to the path request parameter resourceType

    • info

      added the new enum value Specimen to the path request parameter resourceType

    • info

      added the new enum value SpecimenDefinition to the path request parameter resourceType

    • info

      added the new enum value StructureDefinition to the path request parameter resourceType

    • info

      added the new enum value StructureMap to the path request parameter resourceType

    • info

      added the new enum value Subscription to the path request parameter resourceType

    • info

      added the new enum value Substance to the path request parameter resourceType

    • info

      added the new enum value SubstanceNucleicAcid to the path request parameter resourceType

    • info

      added the new enum value SubstancePolymer to the path request parameter resourceType

    • info

      added the new enum value SubstanceProtein to the path request parameter resourceType

    • info

      added the new enum value SubstanceReferenceInformation to the path request parameter resourceType

    • info

      added the new enum value SubstanceSourceMaterial to the path request parameter resourceType

    • info

      added the new enum value SubstanceSpecification to the path request parameter resourceType

    • info

      added the new enum value SupplyDelivery to the path request parameter resourceType

    • info

      added the new enum value SupplyRequest to the path request parameter resourceType

    • info

      added the new enum value Task to the path request parameter resourceType

    • info

      added the new enum value TerminologyCapabilities to the path request parameter resourceType

    • info

      added the new enum value TestReport to the path request parameter resourceType

    • info

      added the new enum value TestScript to the path request parameter resourceType

    • info

      added the new enum value User to the path request parameter resourceType

    • info

      added the new enum value UserConfiguration to the path request parameter resourceType

    • info

      added the new enum value UserSecurityRequest to the path request parameter resourceType

    • info

      added the new enum value ValueSet to the path request parameter resourceType

    • info

      added the new enum value VerificationResult to the path request parameter resourceType

    • info

      added the new enum value VisionPrescription to the path request parameter resourceType