Medplum Fhir API
The Fhir API from Medplum — 4 operation(s) for fhir.
Medplum Fhir API is one of 4 APIs that Medplum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 9 JSON Schema definitions.
Tagged areas include FHIR. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and 9 JSON Schemas.
This API exposes 8 operations across 4 paths, and defines 726 schemas. It is described by OpenAPI 3.1.0, at version 1.0.5.
Requests are made against a single base URL, https://api.medplum.com/.
8 operations
4 paths
726 schemas
1 DELETE4 GET1 PATCH1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Medplum Fhir API declares
3 security schemes
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
It accepts HTTP bearer tokens (JWT) (BearerAuth).
It supports OpenID Connect (OpenID) discovered at https://api.medplum.com/.well-known/openid-configuration.
By default, every request must be authenticated.
Paths & Operations 8
Across 4 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Fhir 8
GET
/fhir/R4/{resourceType}
Search
POST
/fhir/R4/{resourceType}
Create Resource
GET
/fhir/R4/{resourceType}/{id}
Read Resource
PUT
/fhir/R4/{resourceType}/{id}
Update Resource
DELETE
/fhir/R4/{resourceType}/{id}
Delete Resource
PATCH
/fhir/R4/{resourceType}/{id}
Patch Resource
GET
/fhir/R4/{resourceType}/{id}/_history
Read Resource History
GET
/fhir/R4/{resourceType}/{id}/_history/{versionId}
Read Version
Schemas 726
The contract defines 726 schemas that model the data the API accepts and returns. The most detailed are ElementDefinition (200 properties), StructureMap_Source (63 properties), ActivityDefinition (62 properties), Parameters_Parameter (56 properties). Each schema is shown below with its type and property counts.
ExampleScenario_Actor
object
Example of workflow instance.
7 properties
TestScript_Action
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
5 properties
Condition_Evidence
object
A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
5 properties
RelatedPerson_Communication
object
Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care pro…
5 properties
1 required
MedicinalProduct_NamePart
object
Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).
5 properties
1 required
EnrollmentResponse
object
This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.
17 properties
1 required
oid
string
An OID represented as a URI
PackageRelease
object
Definition of a marketplace package release, which represents a specific release of a package that can be installed and used by a system.
14 properties
4 required
Composition_Event
object
A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establis…
6 properties
MedicinalProductPharmaceutical_WithdrawalPeriod
object
A pharmaceutical product described in terms of its composition and dose form.
6 properties
2 required
Bundle_Entry
object
A container for a collection of resources.
9 properties
ClaimResponse_Detail
object
This resource provides the adjudication details from the processing of a Claim resource.
7 properties
1 required
MedicationKnowledge_AdministrationGuidelines
object
Information about a medication that is used to support knowledge.
7 properties
EffectEvidenceSynthesis_EffectEstimate
object
The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from…
9 properties
TerminologyCapabilities_Translation
object
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server fu…
4 properties
AgentChannel
object
Details where to send notifications when resources are received that meet the criteria.
4 properties
2 required
PlanDefinition_Target
object
This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support…
8 properties
ValueSet_Filter
object
A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[…
6 properties
CompartmentDefinition_Resource
object
A compartment definition that defines how resources are accessed on a server.
6 properties
SubstanceSourceMaterial_Author
object
Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified t…
5 properties
MedicationRequest_Substitution
object
An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "Medicatio…
6 properties
MessageDefinition_AllowedResponse
object
Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmit…
5 properties
1 required
ImplementationGuide_DependsOn
object
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gath…
6 properties
1 required
Count
object
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amou…
7 properties
Observation_ReferenceRange
object
Measurements and simple assertions made about a patient, device or other subject.
9 properties
EpisodeOfCare
object
An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level…
21 properties
2 required
ExampleScenario_Step
object
Example of workflow instance.
7 properties
Immunization_Reaction
object
Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.
6 properties
Person
object
Demographics and administrative information about a person independent of a specific health-related context.
19 properties
1 required
DataRequirement_CodeFilter
object
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
7 properties
GraphDefinition_Compartment
object
A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition r…
8 properties
CapabilityStatement_Operation
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
6 properties
1 required
ExplanationOfBenefit_Detail
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
17 properties
1 required
Substance_Instance
object
A homogeneous material with a definite composition.
6 properties
NutritionOrder_OralDiet
object
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
9 properties
SupplyRequest_Parameter
object
A record of a request for a medication, substance or device used in the healthcare setting.
8 properties
ConceptMap_Group
object
A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, o…
9 properties
1 required
CapabilityStatement_Interaction1
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
5 properties
ViewDefinitionSelect
object
The select structure defines the columns to be used in the resulting view. These are expressed in the column structure below, or in nested selects for nested r…
8 properties
ClaimResponse_Detail1
object
This resource provides the adjudication details from the processing of a Claim resource.
12 properties
2 required
MedicationKnowledge_Monograph
object
Information about a medication that is used to support knowledge.
5 properties
MessageHeader_Destination
object
The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other in…
7 properties
MessageDefinition_Focus
object
Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmit…
7 properties
MedicationKnowledge_Kinetics
object
Information about a medication that is used to support knowledge.
6 properties
dateTime
string
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union o…
CoverageEligibilityRequest_SupportingInfo
object
The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResp…
6 properties
1 required
MedicationKnowledge_Packaging
object
Information about a medication that is used to support knowledge.
5 properties
Substance
object
A homogeneous material with a definite composition.
16 properties
2 required
SubstanceProtein
object
A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a define…
13 properties
1 required
ViewDefinitionSelectColumn
object
A column to be produced in the resulting table. The column is relative to the select structure that contains it.
9 properties
2 required
Patient_Contact
object
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
10 properties
AdverseEvent_Causality
object
Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare set…
7 properties
ClaimResponse_SubDetail1
object
This resource provides the adjudication details from the processing of a Claim resource.
11 properties
2 required
date
string
A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHA…
SubstanceNucleicAcid_Subunit
object
Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements.…
11 properties
DiagnosticReport
object
The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The…
28 properties
2 required
ServiceRequest
object
A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
47 properties
2 required
EffectEvidenceSynthesis_Certainty
object
The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from…
6 properties
TestReport_Setup
object
A summary of information based on the results of executing a TestScript.
4 properties
1 required
AllergyIntolerance
object
Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
29 properties
2 required
SubstancePolymer_StartingMaterial
object
Todo.
7 properties
ClaimResponse_Item
object
This resource provides the adjudication details from the processing of a Claim resource.
7 properties
1 required
Bot
object
Bot account for automated actions.
28 properties
1 required
Patient
object
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
27 properties
1 required
CommunicationRequest
object
A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health a…
32 properties
1 required
TestReport_Assert
object
A summary of information based on the results of executing a TestScript.
6 properties
EffectEvidenceSynthesis_CertaintySubcomponent
object
The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from…
6 properties
MedicationRequest
object
An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "Medicatio…
43 properties
2 required
PractitionerRole_AvailableTime
object
A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
7 properties
ExplanationOfBenefit_Financial
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
9 properties
1 required
EffectEvidenceSynthesis_SampleSize
object
The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from…
6 properties
Appointment_Participant
object
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more…
8 properties
DeviceDefinition_DeviceName
object
The characteristics, operational status and capabilities of a medical-related component of a medical device.
5 properties
ValueSet_Parameter
object
A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[…
11 properties
MessageHeader
object
The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other in…
21 properties
2 required
MedicationKnowledge_PatientCharacteristics
object
Information about a medication that is used to support knowledge.
6 properties
ChargeItemDefinition_PropertyGroup
object
The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ…
5 properties
Specimen_Processing
object
A sample to be used for analysis.
8 properties
CommunicationRequest_Payload
object
A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health a…
6 properties
UserSecurityRequest
object
User security request for the 'forgot password' flow, email verification, etc.
14 properties
3 required
ExampleScenario_Operation
object
Example of workflow instance.
13 properties
ProjectMembership
object
Medplum project membership. A project membership grants a user access to a project.
21 properties
4 required
QuestionnaireResponse
object
A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of…
20 properties
1 required
markdown
string
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
DeviceMetric_Calibration
object
Describes a measurement, calculation or setting capability of a medical device.
6 properties
Claim_CareTeam
object
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reim…
8 properties
1 required
Consent_Data
object
A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given…
5 properties
1 required
ExplanationOfBenefit_AddItem
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
24 properties
1 required
AccessPolicy
object
Access Policy for user or user group that defines how entities can or cannot access resources.
14 properties
1 required
DeviceDefinition_UdiDeviceIdentifier
object
The characteristics, operational status and capabilities of a medical-related component of a medical device.
6 properties
boolean
boolean
Value of "true" or "false"
AgentSetting
object
The settings for the agent.
5 properties
1 required
MedicinalProductIndication_OtherTherapy
object
Indication for the Medicinal Product.
6 properties
1 required
HealthcareService
object
The details of a healthcare service available at a location.
34 properties
1 required
Device
object
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medica…
35 properties
1 required
SubstanceReferenceInformation_Gene
object
Todo.
6 properties
Task_Output
object
A task to be performed.
54 properties
1 required
Subscription_Channel
object
The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the s…
7 properties
Coverage_Class
object
Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
6 properties
1 required
CapabilityStatement
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
35 properties
1 required
Medication_Batch
object
This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medicati…
5 properties
MolecularSequence_Inner
object
Raw data describing a biological sequence.
5 properties
HumanName
object
A human's name with the ability to identify parts and usage.
9 properties
CodeSystem_Property1
object
The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define…
11 properties
BiologicallyDerivedProduct
object
A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.
20 properties
1 required
ElementDefinition_Example
object
Captures constraints on each element within the resource, profile, or extension.
54 properties
PlanDefinition_RelatedAction
object
This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support…
7 properties
DocumentReference_Content
object
A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a…
5 properties
1 required
ResearchDefinition
object
The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified)…
44 properties
2 required
CapabilityStatement_Implementation
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
6 properties
CoverageEligibilityResponse_Item
object
This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
17 properties
MedicinalProductInteraction
object
The interactions of the medicinal product with other medicinal products, or other forms of interactions.
16 properties
1 required
MedicinalProductPackaged_BatchIdentifier
object
A medicinal product in a container or package.
5 properties
1 required
MessageHeader_Response
object
The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other in…
6 properties
Invoice
object
Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
25 properties
1 required
Contract_Term
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
16 properties
1 required
PractitionerRole_NotAvailable
object
A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
5 properties
ExplanationOfBenefit_Adjudication
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
7 properties
1 required
ChargeItemDefinition
object
The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ…
32 properties
1 required
CodeSystem_Concept
object
The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define…
9 properties
TerminologyCapabilities
object
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server fu…
33 properties
1 required
Measure_Stratifier
object
The Measure resource provides the definition of a quality measure.
7 properties
Composition_Attester
object
A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establis…
6 properties
EpisodeOfCare_StatusHistory
object
An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level…
5 properties
1 required
EpisodeOfCare_Diagnosis
object
An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level…
6 properties
1 required
ExplanationOfBenefit_SubDetail1
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
11 properties
1 required
Person_Link
object
Demographics and administrative information about a person independent of a specific health-related context.
5 properties
1 required
RequestGroup_RelatedAction
object
A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
7 properties
ExampleScenario
object
Example of workflow instance.
26 properties
1 required
TerminologyCapabilities_Expansion
object
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server fu…
8 properties
Invoice_PriceComponent
object
Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
7 properties
MedicinalProduct_SpecialDesignation
object
Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).
11 properties
MedicinalProductContraindication
object
The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.
16 properties
1 required
SubstanceSpecification_Structure
object
The detailed description of a substance, typically at a level beyond what is used for prescribing.
11 properties
ValueSet_Expansion
object
A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[…
9 properties
TerminologyCapabilities_Filter
object
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server fu…
5 properties
DeviceDefinition
object
The characteristics, operational status and capabilities of a medical-related component of a medical device.
33 properties
1 required
ExampleScenario_Version
object
Example of workflow instance.
5 properties
OperationDefinition_Binding
object
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
5 properties
1 required
SubstanceSpecification_Code
object
The detailed description of a substance, typically at a level beyond what is used for prescribing.
8 properties
Appointment
object
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more…
31 properties
2 required
CoverageEligibilityResponse_Error
object
This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
4 properties
1 required
AuditEvent_Source
object
A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usa…
6 properties
1 required
UserConfigurationSearch
object
Shortcut links to URLs.
2 properties
2 required
Claim_Payee
object
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reim…
5 properties
1 required
Timing
object
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common…
6 properties
ViewDefinitionConstant
object
A constant is a value that is injected into a FHIRPath expression through the use of a FHIRPath external constant with the same name.
23 properties
1 required
BulkDataExportDeleted
object
An array of deleted file items following the same structure as the output array.
2 properties
2 required
ImplementationGuide_Template
object
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gath…
6 properties
ParameterDefinition
object
The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evalu…
9 properties
InsurancePlan_Benefit
object
Details of a Health Insurance product/plan provided by an organization.
6 properties
1 required
ElementDefinition_Type
object
Captures constraints on each element within the resource, profile, or extension.
8 properties
Linkage_Item
object
Identifies two or more records (resource instances) that refer to the same real-world "occurrence".
5 properties
1 required
Contract_Friendly
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
5 properties
Condition_Stage
object
A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
6 properties
MedicinalProductPharmaceutical_RouteOfAdministration
object
A pharmaceutical product described in terms of its composition and dose form.
10 properties
1 required
BotCdsService
object
CDS service definition if the bot is used as a CDS Hooks service. See https://cds-hooks.hl7.org/ for more details.
5 properties
3 required
SmartAppLaunch
object
This resource contains context details for a SMART App Launch.
12 properties
1 required
DetectedIssue_Evidence
object
Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Inef…
5 properties
Population
object
A populatioof people with some set of grouping criteria.
8 properties
ValueSet_Contains
object
A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[…
11 properties
ElementDefinition_Base
object
Captures constraints on each element within the resource, profile, or extension.
6 properties
ResearchElementDefinition
object
The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
43 properties
2 required
PractitionerRole
object
A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
23 properties
1 required
StructureMap_Rule
object
A Map of relationships between 2 structures that can be used to transform data.
9 properties
1 required
MedicationKnowledge_Schedule
object
Information about a medication that is used to support knowledge.
4 properties
1 required
AsyncJob
object
Contains details of long running asynchronous/background jobs.
17 properties
4 required
Coding
object
A reference to a code defined by a terminology system.
7 properties
TestScript_Teardown
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
4 properties
1 required
UserConfiguration
object
User specific configuration for the Medplum application.
13 properties
1 required
Procedure_FocalDevice
object
An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counse…
5 properties
1 required
GraphDefinition_Target
object
A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition r…
8 properties
CoverageEligibilityRequest
object
The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResp…
24 properties
3 required
Address
object
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use…
12 properties
SpecimenDefinition_Additive
object
A kind of specimen with associated set of requirements.
5 properties
Coverage_Exception
object
Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
5 properties
1 required
Practitioner
object
A person who is directly or indirectly involved in the provisioning of healthcare.
19 properties
1 required
AccessPolicyResource
object
Access details for a resource type.
8 properties
1 required
Communication
object
An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reporta…
32 properties
1 required
VerificationResult_Attestation
object
Describes validation requirements, source(s), status and dates for one or more elements.
11 properties
TestReport_Operation
object
A summary of information based on the results of executing a TestScript.
6 properties
ExplanationOfBenefit_CareTeam
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
8 properties
1 required
SupplyDelivery
object
Record of delivery of what is supplied.
22 properties
1 required
InsurancePlan_Limit
object
Details of a Health Insurance product/plan provided by an organization.
5 properties
CoverageEligibilityRequest_Diagnosis
object
The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResp…
5 properties
Contract_Context
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
6 properties
TestReport_Teardown
object
A summary of information based on the results of executing a TestScript.
4 properties
1 required
Attachment
object
For referring to data content defined in other formats.
10 properties
TerminologyCapabilities_Parameter
object
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server fu…
5 properties
ClaimResponse_Total
object
This resource provides the adjudication details from the processing of a Claim resource.
5 properties
2 required
Extension
object
Optional Extension Element - found in all resources.
53 properties
ConceptMap_Unmapped
object
A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, o…
7 properties
AuditEvent
object
A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usa…
20 properties
4 required
Contract_Offer
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
13 properties
ConceptMap_Target
object
A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, o…
9 properties
ResearchStudy_Arm
object
A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This inc…
6 properties
Claim_Related
object
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reim…
6 properties
Group_Member
object
Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formal…
6 properties
1 required
SubstanceAmount_ReferenceRange
object
Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of…
5 properties
BiologicallyDerivedProduct_Processing
object
A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.
8 properties
StructureMap_Structure
object
A Map of relationships between 2 structures that can be used to transform data.
7 properties
1 required
Questionnaire_Item
object
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phr…
19 properties
TestReport_Test
object
A summary of information based on the results of executing a TestScript.
6 properties
1 required
FamilyMemberHistory_Condition
object
Significant health conditions for a person related to the patient relevant in the context of care for the patient.
11 properties
1 required
CodeSystem_Designation
object
The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define…
6 properties
StructureDefinition_Differential
object
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions an…
4 properties
1 required
ImmunizationRecommendation
object
A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
14 properties
3 required
Package
object
Definition of a marketplace package, which represents a set of automated actions that can be taken by a system, such as a subscription or a workflow.
15 properties
4 required
ImplementationGuide_Global
object
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gath…
5 properties
1 required
EvidenceVariable
object
The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
36 properties
2 required
VerificationResult
object
Describes validation requirements, source(s), status and dates for one or more elements.
23 properties
1 required
Money
object
An amount of economic utility in some recognized currency.
4 properties
Composition_Section
object
A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establis…
13 properties
Evidence
object
The Evidence resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the k…
37 properties
2 required
url
string
A URI that is a literal reference
Contract_ValuedItem
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
18 properties
TerminologyCapabilities_Version
object
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server fu…
9 properties
Claim_Accident
object
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reim…
7 properties
SubstancePolymer
object
Todo.
15 properties
1 required
MeasureReport_Component
object
The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.
5 properties
2 required
PaymentNotice
object
This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
21 properties
4 required
MolecularSequence
object
Raw data describing a biological sequence.
25 properties
1 required
TerminologyCapabilities_ValidateCode
object
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server fu…
4 properties
ExplanationOfBenefit_BenefitBalance
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
11 properties
1 required
ActivityDefinition_DynamicValue
object
This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
5 properties
1 required
StructureMap_Input
object
A Map of relationships between 2 structures that can be used to transform data.
7 properties
Patient_Communication
object
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
5 properties
1 required
TestReport_Action
object
A summary of information based on the results of executing a TestScript.
5 properties
MedicinalProductIndication
object
Indication for the Medicinal Product.
18 properties
1 required
Timing_Repeat
object
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common…
20 properties
Contract_Signer
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
6 properties
3 required
SpecimenDefinition
object
A kind of specimen with associated set of requirements.
15 properties
1 required
Immunization_ProtocolApplied
object
Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.
10 properties
CapabilityStatement_Endpoint
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
5 properties
1 required
MolecularSequence_ReferenceSeq
object
Raw data describing a biological sequence.
12 properties
Organization
object
A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies,…
19 properties
1 required
Goal_Target
object
Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd…
13 properties
Encounter_Participant
object
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
6 properties
ImplementationGuide
object
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gath…
29 properties
1 required
InsurancePlan_Benefit1
object
Details of a Health Insurance product/plan provided by an organization.
5 properties
1 required
InsurancePlan_Contact
object
Details of a Health Insurance product/plan provided by an organization.
7 properties
Specimen_Container
object
A sample to be used for analysis.
10 properties
TerminologyCapabilities_Software
object
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server fu…
5 properties
DataRequirement_DateFilter
object
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
8 properties
CapabilityStatement_SearchParam
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
7 properties
Linkage
object
Identifies two or more records (resource instances) that refer to the same real-world "occurrence".
12 properties
2 required
Account
object
A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
20 properties
1 required
List
object
A list is a curated collection of resources.
22 properties
1 required
Consent_Provision
object
A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given…
14 properties
Questionnaire
object
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phr…
31 properties
1 required
Procedure_Performer
object
An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counse…
6 properties
1 required
InsurancePlan_GeneralCost
object
Details of a Health Insurance product/plan provided by an organization.
7 properties
RiskEvidenceSynthesis_CertaintySubcomponent
object
The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combina…
6 properties
Contract_Asset
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
18 properties
PaymentReconciliation_Detail
object
This resource provides the details including amount of a payment and allocates the payment items being paid.
13 properties
1 required
Ratio
object
A relationship of two Quantity values - expressed as a numerator and a denominator.
4 properties
Schedule
object
A container for slots of time that may be available for booking appointments.
17 properties
2 required
ExplanationOfBenefit_Accident
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
7 properties
MedicinalProductPharmaceutical_Characteristics
object
A pharmaceutical product described in terms of its composition and dose form.
5 properties
1 required
canonical
string
A URI that is a reference to a canonical URL on a FHIR resource
MedicinalProductAuthorization_JurisdictionalAuthorization
object
The regulatory authorization of a medicinal product.
8 properties
Bundle_Search
object
A container for a collection of resources.
5 properties
ElementDefinition_Mapping
object
Captures constraints on each element within the resource, profile, or extension.
7 properties
AccessPolicyIpAccessRule
object
Use IP Access Rules to allowlist, block, and challenge traffic based on the visitor IP address.
3 properties
2 required
PlanDefinition_Action
object
This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support…
37 properties
Range
object
A set of ordered Quantities defined by a low and high limit.
4 properties
SubstanceSpecification_MolecularWeight
object
The detailed description of a substance, typically at a level beyond what is used for prescribing.
6 properties
ClientApplication
object
Medplum client application for automated access.
29 properties
1 required
List_Entry
object
A list is a curated collection of resources.
7 properties
1 required
Condition
object
A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
34 properties
2 required
TestScript_RequestHeader
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
5 properties
IdentityProvider
object
External Identity Provider (IdP) configuration details.
8 properties
5 required
Contributor
object
A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
5 properties
AppointmentResponse
object
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
17 properties
2 required
ConceptMap_Element
object
A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, o…
6 properties
PackageInstallation
object
Definition of a marketplace package installation, which represents the installation of a specific package release in a system.
15 properties
6 required
SupplyRequest
object
A record of a request for a medication, substance or device used in the healthcare setting.
27 properties
2 required
ChargeItemDefinition_PriceComponent
object
The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ…
7 properties
RiskAssessment_Prediction
object
An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.
11 properties
ExplanationOfBenefit_Diagnosis
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
9 properties
Medication
object
This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medicati…
17 properties
1 required
DeviceDefinition_Capability
object
The characteristics, operational status and capabilities of a medical-related component of a medical device.
5 properties
1 required
VisionPrescription_LensSpecification
object
An authorization for the provision of glasses and/or contact lenses to a patient.
17 properties
1 required
CodeSystem_Filter
object
The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define…
7 properties
SubstanceSpecification
object
The detailed description of a substance, typically at a level beyond what is used for prescribing.
28 properties
1 required
NutritionOrder
object
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
26 properties
2 required
DataRequirement_Sort
object
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
5 properties
MedicationDispense_Performer
object
Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) p…
5 properties
1 required
AdverseEvent_SuspectEntity
object
Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare set…
5 properties
1 required
SubstanceSourceMaterial_OrganismGeneral
object
Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified t…
7 properties
RiskAssessment
object
An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.
27 properties
2 required
BiologicallyDerivedProduct_Storage
object
A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.
7 properties
CapabilityStatement_Document
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
6 properties
1 required
ExplanationOfBenefit
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
52 properties
6 required
decimal
number
A rational number with implicit precision
Questionnaire_EnableWhen
object
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phr…
15 properties
UserConfigurationMenuLink
object
Shortcut links to URLs.
2 properties
2 required
SearchParameter
object
A search parameter that defines a named search item that can be used to search/filter on a resource.
35 properties
1 required
MedicinalProductIngredient_ReferenceStrength
object
An ingredient of a manufactured item or pharmaceutical product.
8 properties
1 required
MedicationKnowledge_DrugCharacteristic
object
Information about a medication that is used to support knowledge.
8 properties
InsurancePlan_Plan
object
Details of a Health Insurance product/plan provided by an organization.
9 properties
Login
object
Login event and session details.
34 properties
4 required
MedicinalProductManufactured
object
The manufactured item as contained in the packaged medicinal product.
16 properties
3 required
Specimen
object
A sample to be used for analysis.
22 properties
1 required
Medication_Ingredient
object
This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medicati…
7 properties
Distance
object
A length - a value with a unit that is a physical distance.
7 properties
BiologicallyDerivedProduct_Collection
object
A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.
7 properties
ClaimResponse_Adjudication
object
This resource provides the adjudication details from the processing of a Claim resource.
7 properties
1 required
Claim_SupportingInfo
object
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reim…
14 properties
1 required
ProjectMembershipAccessParameter
object
User options that control the display of the application.
3 properties
1 required
TestScript
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
33 properties
1 required
Measure
object
The Measure resource provides the definition of a quality measure.
51 properties
1 required
Claim_Diagnosis
object
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reim…
9 properties
Bundle_Link
object
A container for a collection of resources.
5 properties
RiskEvidenceSynthesis_RiskEstimate
object
The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combina…
10 properties
BulkDataExport
object
User specific configuration for the Medplum application.
17 properties
4 required
ResearchElementDefinition_Characteristic
object
The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
24 properties
MedicationAdministration
object
Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long runni…
30 properties
2 required
MolecularSequence_Quality
object
Raw data describing a biological sequence.
18 properties
SubstanceSourceMaterial_FractionDescription
object
Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified t…
5 properties
CodeableConcept
object
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
4 properties
DetectedIssue_Mitigation
object
Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Inef…
6 properties
1 required
TestScript_Origin
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
5 properties
1 required
Provenance_Agent
object
Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provena…
7 properties
1 required
Contract_Subject
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
5 properties
1 required
CodeSystem_Property
object
The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define…
7 properties
TerminologyCapabilities_Implementation
object
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server fu…
5 properties
AllergyIntolerance_Reaction
object
Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
10 properties
1 required
Consent
object
A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given…
23 properties
3 required
RequestGroup_Condition
object
A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
5 properties
StructureMap
object
A Map of relationships between 2 structures that can be used to transform data.
27 properties
2 required
ImagingStudy_Series
object
Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instanc…
15 properties
1 required
SubstancePolymer_RepeatUnit
object
Todo.
8 properties
TestReport_Action1
object
A summary of information based on the results of executing a TestScript.
5 properties
Immunization_Education
object
Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.
7 properties
MedicinalProductIngredient_Substance
object
An ingredient of a manufactured item or pharmaceutical product.
5 properties
1 required
SubstanceSourceMaterial_Organism
object
Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified t…
11 properties
UserConfigurationOption
object
User options that control the display of the application.
6 properties
1 required
BulkDataExportOutput
object
An array of file items with one entry for each generated file. If no resources are returned from the kick-off request, the server SHOULD return an empty array.
2 properties
2 required
Invoice_Participant
object
Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
5 properties
1 required
SampledData
object
A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
9 properties
1 required
Account_Coverage
object
A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
5 properties
1 required
ClaimResponse_SubDetail
object
This resource provides the adjudication details from the processing of a Claim resource.
6 properties
Observation
object
Measurements and simple assertions made about a patient, device or other subject.
46 properties
2 required
RequestGroup_Action
object
A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
27 properties
MedicationAdministration_Performer
object
Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long runni…
5 properties
1 required
ExampleScenario_Process
object
Example of workflow instance.
8 properties
ExplanationOfBenefit_Total
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
5 properties
2 required
MolecularSequence_Roc
object
Raw data describing a biological sequence.
10 properties
RelatedArtifact
object
Related artifacts such as additional documentation, justification, or bibliographic references.
9 properties
ImplementationGuide_Parameter
object
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gath…
5 properties
MedicationKnowledge_Substitution
object
Information about a medication that is used to support knowledge.
5 properties
1 required
CapabilityStatement_Messaging
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
7 properties
ExplanationOfBenefit_Item
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
29 properties
1 required
TestScript_Capability
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
10 properties
1 required
ExplanationOfBenefit_Detail1
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
12 properties
1 required
Encounter_ClassHistory
object
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
5 properties
2 required
MeasureReport_Stratifier
object
The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.
5 properties
Observation_Component
object
Measurements and simple assertions made about a patient, device or other subject.
18 properties
1 required
ImplementationGuide_Definition
object
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gath…
8 properties
1 required
DeviceMetric
object
Describes a measurement, calculation or setting capability of a medical device.
19 properties
2 required
ContactPoint
object
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
7 properties
SubstancePolymer_MonomerSet
object
Todo.
5 properties
Composition
object
A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establis…
24 properties
3 required
Agent
object
Configuration details for an instance of the Medplum agent application.
15 properties
3 required
StructureDefinition_Context
object
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions an…
5 properties
ClaimResponse_Error
object
This resource provides the adjudication details from the processing of a Claim resource.
7 properties
1 required
Device_UdiCarrier
object
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medica…
9 properties
Quantity
object
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amou…
7 properties
ValueSet_Concept
object
A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[…
6 properties
OperationOutcome
object
A collection of error, warning, or information messages that result from a system action.
12 properties
2 required
TriggerDefinition
object
A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
10 properties
ImplementationGuide_Resource1
object
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gath…
7 properties
1 required
ImmunizationEvaluation
object
Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommenda…
24 properties
5 required
unsignedInt
number
An integer with a value that is not negative (e.g. = 0)
ClaimResponse_ProcessNote
object
This resource provides the adjudication details from the processing of a Claim resource.
7 properties
Patient_Link
object
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
5 properties
1 required
User
object
Representation of a human user of the system.
21 properties
3 required
VerificationResult_PrimarySource
object
Describes validation requirements, source(s), status and dates for one or more elements.
10 properties
ValueSet_Designation
object
A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[…
6 properties
OperationDefinition_Overload
object
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
5 properties
ProjectSetting
object
Option or parameter that can be adjusted within the Medplum Project to customize its behavior.
5 properties
1 required
StructureMap_Target
object
A Map of relationships between 2 structures that can be used to transform data.
11 properties
HealthcareService_Eligibility
object
The details of a healthcare service available at a location.
5 properties
QuestionnaireResponse_Answer
object
A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of…
16 properties
ImplementationGuide_Page1
object
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gath…
6 properties
Bundle_Response
object
A container for a collection of resources.
8 properties
TestScript_Fixture
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
6 properties
ConceptMap_DependsOn
object
A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, o…
7 properties
GraphDefinition_Link
object
A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition r…
9 properties
CarePlan_Detail
object
Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly lim…
23 properties
ResearchStudy
object
A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This inc…
33 properties
1 required
PlanDefinition_Goal
object
This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support…
10 properties
1 required
AdverseEvent
object
Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare set…
29 properties
2 required
OperationDefinition_ReferencedFrom
object
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
5 properties
StructureMap_Dependent
object
A Map of relationships between 2 structures that can be used to transform data.
5 properties
ImplementationGuide_Page
object
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gath…
8 properties
RiskEvidenceSynthesis_SampleSize
object
The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combina…
6 properties
VerificationResult_Validator
object
Describes validation requirements, source(s), status and dates for one or more elements.
6 properties
1 required
Invoice_LineItem
object
Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
7 properties
ContactDetail
object
Specifies contact information for a person or organization.
4 properties
MedicinalProduct_Name
object
Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).
6 properties
TestScript_Action1
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
5 properties
MedicinalProductAuthorization
object
The regulatory authorization of a medicinal product.
25 properties
1 required
MedicinalProductPackaged_PackageItem
object
A medicinal product in a container or package.
15 properties
2 required
ImplementationGuide_Resource
object
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gath…
10 properties
1 required
MessageHeader_Source
object
The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other in…
8 properties
Dosage
object
Indicates how the medication is/was taken or should be taken by the patient.
17 properties
SubstanceNucleicAcid
object
Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements.…
14 properties
1 required
ElementDefinition_Constraint
object
Captures constraints on each element within the resource, profile, or extension.
10 properties
Encounter_Hospitalization
object
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
12 properties
NutritionOrder_Administration
object
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
7 properties
Communication_Payload
object
An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reporta…
6 properties
CompartmentDefinition
object
A compartment definition that defines how resources are accessed on a server.
23 properties
1 required
ClinicalImpression_Investigation
object
A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies tha…
5 properties
1 required
TestReport
object
A summary of information based on the results of executing a TestScript.
21 properties
2 required
time
string
A time during the day, with no date specified
Measure_Population
object
The Measure resource provides the definition of a quality measure.
6 properties
1 required
Goal
object
Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd…
26 properties
3 required
string
string
A sequence of Unicode characters
Task_Input
object
A task to be performed.
54 properties
1 required
Contract_Action
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
26 properties
3 required
Parameters
object
This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RES…
6 properties
1 required
Device_DeviceName
object
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medica…
5 properties
InsurancePlan
object
Details of a Health Insurance product/plan provided by an organization.
23 properties
1 required
StructureDefinition_Snapshot
object
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions an…
4 properties
1 required
MedicinalProductAuthorization_Procedure
object
The regulatory authorization of a medicinal product.
8 properties
1 required
MedicationKnowledge_MonitoringProgram
object
Information about a medication that is used to support knowledge.
5 properties
SubstanceSpecification_Relationship
object
The detailed description of a substance, typically at a level beyond what is used for prescribing.
14 properties
ImplementationGuide_Manifest
object
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gath…
8 properties
1 required
DiagnosticReport_Media
object
The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The…
5 properties
1 required
Expression
object
A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expressio…
7 properties
MeasureReport_Population1
object
The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.
6 properties
Task
object
A task to be performed.
40 properties
1 required
Device_Version
object
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medica…
6 properties
MedicinalProductIngredient
object
An ingredient of a manufactured item or pharmaceutical product.
15 properties
2 required
BodyStructure
object
Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.
17 properties
2 required
Group
object
Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formal…
19 properties
1 required
PaymentReconciliation_ProcessNote
object
This resource provides the details including amount of a payment and allocates the payment items being paid.
5 properties
Group_Characteristic
object
Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formal…
11 properties
1 required
PlanDefinition_DynamicValue
object
This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support…
5 properties
ExplanationOfBenefit_Payee
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
5 properties
AuditEvent_Network
object
A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usa…
5 properties
SubstancePolymer_Repeat
object
Todo.
7 properties
ResourceList
Contract_Party
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
5 properties
2 required
ClaimResponse_AddItem
object
This resource provides the adjudication details from the processing of a Claim resource.
24 properties
2 required
SubstanceReferenceInformation_Classification
object
Todo.
7 properties
Location_HoursOfOperation
object
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodat…
7 properties
TestScript_Variable
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
11 properties
id
string
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 identi…
SearchParameter_Component
object
A search parameter that defines a named search item that can be used to search/filter on a resource.
5 properties
1 required
CoverageEligibilityResponse_Insurance
object
This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
7 properties
1 required
OrganizationAffiliation
object
Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.
21 properties
1 required
PaymentReconciliation
object
This resource provides the details including amount of a payment and allocates the payment items being paid.
24 properties
2 required
MedicationKnowledge
object
Information about a medication that is used to support knowledge.
31 properties
1 required
Claim
object
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reim…
36 properties
6 required
ElementDefinition_Slicing
object
Captures constraints on each element within the resource, profile, or extension.
7 properties
SpecimenDefinition_Container
object
A kind of specimen with associated set of requirements.
12 properties
Consent_Verification
object
A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given…
6 properties
ExampleScenario_Instance
object
Example of workflow instance.
9 properties
MedicationAdministration_Dosage
object
Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long runni…
10 properties
SubstanceSpecification_Isotope
object
The detailed description of a substance, typically at a level beyond what is used for prescribing.
8 properties
AuditEvent_Entity
object
A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usa…
12 properties
Measure_SupplementalData
object
The Measure resource provides the definition of a quality measure.
7 properties
1 required
CoverageEligibilityResponse_Benefit
object
This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
10 properties
1 required
MedicationDispense_Substitution
object
Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) p…
7 properties
Bundle_Request
object
A container for a collection of resources.
9 properties
CareTeam
object
The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
22 properties
1 required
DeviceDefinition_Specialization
object
The characteristics, operational status and capabilities of a medical-related component of a medical device.
5 properties
DocumentReference
object
A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a…
25 properties
2 required
MedicinalProductContraindication_OtherTherapy
object
The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.
6 properties
1 required
TerminologyCapabilities_Closure
object
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server fu…
4 properties
NamingSystem
object
A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used withi…
22 properties
2 required
ClaimResponse
object
This resource provides the adjudication details from the processing of a Claim resource.
36 properties
4 required
NamingSystem_UniqueId
object
A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used withi…
8 properties
PlanDefinition_Participant
object
This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support…
5 properties
SupplyDelivery_SuppliedItem
object
Record of delivery of what is supplied.
6 properties
TestScript_Test
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
6 properties
1 required
OperationDefinition
object
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
35 properties
1 required
Organization_Contact
object
A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies,…
7 properties
Contract_Answer
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
15 properties
Signature
object
A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the…
9 properties
2 required
SpecimenDefinition_TypeTested
object
A kind of specimen with associated set of requirements.
11 properties
Location
object
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodat…
26 properties
1 required
instant
string
An instant in time - known at least to the second
CatalogEntry_RelatedEntry
object
Catalog entries are wrappers that contextualize items included in a catalog.
5 properties
1 required
ElementDefinition_Discriminator
object
Captures constraints on each element within the resource, profile, or extension.
5 properties
MedicationKnowledge_Ingredient
object
Information about a medication that is used to support knowledge.
7 properties
GraphDefinition
object
A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition r…
24 properties
1 required
VisionPrescription
object
An authorization for the provision of glasses and/or contact lenses to a patient.
17 properties
4 required
CareTeam_Participant
object
The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
7 properties
EnrollmentRequest
object
This resource provides the insurance enrollment details to the insurer regarding a specified coverage.
16 properties
1 required
ElementDefinition
object
Captures constraints on each element within the resource, profile, or extension.
200 properties
SubstanceSourceMaterial
object
Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified t…
22 properties
1 required
CoverageEligibilityResponse
object
This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
25 properties
4 required
PlanDefinition_Condition
object
This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support…
5 properties
SubstanceNucleicAcid_Sugar
object
Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements.…
6 properties
MedicationKnowledge_RelatedMedicationKnowledge
object
Information about a medication that is used to support knowledge.
5 properties
2 required
InsurancePlan_Coverage
object
Details of a Health Insurance product/plan provided by an organization.
6 properties
2 required
StructureMap_Parameter
object
A Map of relationships between 2 structures that can be used to transform data.
8 properties
NutritionOrder_Supplement
object
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
8 properties
NutritionOrder_Nutrient
object
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
5 properties
SubstancePolymer_StructuralRepresentation
object
Todo.
6 properties
BotCdsServicePrefetch
object
An object containing key/value pairs of FHIR queries that this service is requesting the CDS Client to perform and provide on each service call.
2 properties
2 required
Coverage
object
Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
26 properties
3 required
integer
number
A whole number
Contract_SecurityLabel
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
7 properties
1 required
ImmunizationRecommendation_Recommendation
object
A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
17 properties
1 required
Immunization_Performer
object
Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.
5 properties
1 required
CodeSystem
object
The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define…
35 properties
1 required
CapabilityStatement_Rest
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
11 properties
DocumentReference_Context
object
A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a…
10 properties
Identifier
object
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
8 properties
Coverage_CostToBeneficiary
object
Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
7 properties
SubstanceSourceMaterial_Hybrid
object
Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified t…
8 properties
SubstanceSpecification_Official
object
The detailed description of a substance, typically at a level beyond what is used for prescribing.
6 properties
SubstanceSourceMaterial_PartDescription
object
Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified t…
5 properties
DeviceDefinition_Material
object
The characteristics, operational status and capabilities of a medical-related component of a medical device.
6 properties
1 required
Practitioner_Qualification
object
A person who is directly or indirectly involved in the provisioning of healthcare.
7 properties
1 required
base64Binary
string
A stream of bytes
MeasureReport
object
The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.
20 properties
3 required
UsageContext
object
Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applic…
7 properties
1 required
Questionnaire_AnswerOption
object
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phr…
10 properties
Flag
object
Prospective warnings of potential issues when providing care to the patient.
17 properties
3 required
DetectedIssue
object
Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Inef…
22 properties
1 required
Encounter_Location
object
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
7 properties
1 required
SubstanceSpecification_Name
object
The detailed description of a substance, typically at a level beyond what is used for prescribing.
14 properties
EffectEvidenceSynthesis_PrecisionEstimate
object
The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from…
7 properties
ExplanationOfBenefit_Related
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
6 properties
UserConfigurationMenu
object
Optional menu of shortcuts to URLs.
2 properties
1 required
InsurancePlan_SpecificCost
object
Details of a Health Insurance product/plan provided by an organization.
5 properties
1 required
ImagingStudy
object
Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instanc…
29 properties
2 required
MessageDefinition
object
Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmit…
34 properties
1 required
ExplanationOfBenefit_Procedure
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
9 properties
VisionPrescription_Prism
object
An authorization for the provision of glasses and/or contact lenses to a patient.
5 properties
Device_Property
object
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medica…
6 properties
1 required
Project
object
Encapsulation of resources for a specific project or organization.
26 properties
1 required
MeasureReport_Group
object
The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.
7 properties
TestReport_Participant
object
A summary of information based on the results of executing a TestScript.
6 properties
MedicationRequest_DispenseRequest
object
An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "Medicatio…
10 properties
BiologicallyDerivedProduct_Manipulation
object
A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.
6 properties
StructureDefinition
object
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions an…
36 properties
1 required
SubstanceAmount
object
Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of…
9 properties
MedicinalProductInteraction_Interactant
object
The interactions of the medicinal product with other medicinal products, or other forms of interactions.
5 properties
CarePlan
object
Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly lim…
32 properties
2 required
CapabilityStatement_Interaction
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
5 properties
ImplementationGuide_Grouping
object
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gath…
5 properties
MedicinalProduct_ManufacturingBusinessOperation
object
Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).
9 properties
StructureMap_Source
object
A Map of relationships between 2 structures that can be used to transform data.
63 properties
MedicinalProductPharmaceutical_TargetSpecies
object
A pharmaceutical product described in terms of its composition and dose form.
5 properties
1 required
DeviceRequest
object
Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.
36 properties
2 required
Duration
object
A length of time.
7 properties
QuestionnaireResponse_Item
object
A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of…
8 properties
SpecimenDefinition_Handling
object
A kind of specimen with associated set of requirements.
7 properties
HealthcareService_AvailableTime
object
The details of a healthcare service available at a location.
7 properties
TestScript_Setup
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
4 properties
1 required
Task_Restriction
object
A task to be performed.
6 properties
DomainConfiguration
object
Domain specific configuration for the Medplum application.
12 properties
2 required
Slot
object
A slot of time on a schedule that may be available for booking appointments.
20 properties
2 required
ViewDefinitionSelectColumnTag
object
Tags can be used to attach additional metadata to columns, such as implementation-specific directives or database-specific type hints.
5 properties
2 required
Reference
object
A reference from one resource to another.
7 properties
TestScript_Destination
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
5 properties
1 required
MeasureReport_Stratum
object
The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.
7 properties
ClaimResponse_Payment
object
This resource provides the adjudication details from the processing of a Claim resource.
9 properties
2 required
Subscription
object
The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the s…
16 properties
2 required
Meta
object
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated…
12 properties
ProdCharacteristic
object
The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
14 properties
ClinicalImpression
object
A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies tha…
30 properties
2 required
Questionnaire_Initial
object
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phr…
15 properties
DeviceDefinition_Classification
object
What kind of device or device system this is.
5 properties
FamilyMemberHistory
object
Significant health conditions for a person related to the patient relevant in the context of care for the patient.
35 properties
3 required
EffectEvidenceSynthesis
object
The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from…
42 properties
5 required
RiskEvidenceSynthesis_PrecisionEstimate
object
The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combina…
7 properties
MedicationKnowledge_MedicineClassification
object
Information about a medication that is used to support knowledge.
5 properties
1 required
CatalogEntry
object
Catalog entries are wrappers that contextualize items included in a catalog.
22 properties
2 required
Account_Guarantor
object
A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
6 properties
1 required
xhtml
xhtml - escaped html (see specfication)
HealthcareService_NotAvailable
object
The details of a healthcare service available at a location.
5 properties
ClientApplicationSignInForm
object
Custom values for the Log In form.
2 properties
DeviceUseStatement
object
A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.
24 properties
3 required
ViewDefinition
object
View definitions represent a tabular projection of a FHIR resource, where the columns and inclusion criteria are defined by FHIRPath expressions.
17 properties
3 required
Procedure
object
An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counse…
41 properties
2 required
Encounter
object
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
32 properties
2 required
MedicinalProduct
object
Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).
29 properties
2 required
DocumentManifest
object
A collection of documents compiled for a purpose together with metadata that applies to the collection.
21 properties
2 required
Claim_Procedure
object
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reim…
9 properties
MedicationRequest_InitialFill
object
An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "Medicatio…
5 properties
TerminologyCapabilities_CodeSystem
object
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server fu…
6 properties
ConceptMap
object
A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, o…
29 properties
1 required
EvidenceVariable_Characteristic
object
The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
18 properties
Consent_Actor
object
A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given…
5 properties
2 required
SubstancePolymer_DegreeOfPolymerisation
object
Todo.
5 properties
RequestGroup
object
A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
27 properties
1 required
TestScript_Assert
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
25 properties
DocumentReference_RelatesTo
object
A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a…
5 properties
1 required
SubstanceSpecification_Moiety
object
The detailed description of a substance, typically at a level beyond what is used for prescribing.
11 properties
Device_Specialization
object
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medica…
5 properties
1 required
Period
object
A time period defined by a start and end date and optionally time.
4 properties
ValueSet_Include
object
A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[…
8 properties
Contract_ContentDefinition
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
9 properties
1 required
ChargeItem_Performer
object
The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but contain…
5 properties
1 required
ViewDefinitionWhere
object
A series of zero or more FHIRPath constraints to filter resources for the view. Every constraint must evaluate to true for the resource to be included in the v…
5 properties
1 required
ObservationDefinition
object
Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.
23 properties
2 required
TestScript_Link
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
5 properties
Bundle
object
A container for a collection of resources.
12 properties
1 required
MedicinalProductIngredient_Strength
object
An ingredient of a manufactured item or pharmaceutical product.
10 properties
1 required
NutritionOrder_EnteralFormula
object
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
12 properties
MedicationKnowledge_Cost
object
Information about a medication that is used to support knowledge.
6 properties
2 required
DataRequirement
object
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
11 properties
JsonWebKey
object
A JSON object that represents a cryptographic key. The members of the object represent properties of the key, including its value.
28 properties
3 required
RiskEvidenceSynthesis
object
The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combina…
40 properties
3 required
TestScript_Operation
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
20 properties
Specimen_Collection
object
A sample to be used for analysis.
12 properties
SubstanceSpecification_Property
object
The detailed description of a substance, typically at a level beyond what is used for prescribing.
10 properties
Measure_Component
object
The Measure resource provides the definition of a quality measure.
6 properties
1 required
TestScript_Action2
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
4 properties
1 required
MedicationKnowledge_Regulatory
object
Information about a medication that is used to support knowledge.
7 properties
1 required
SubstanceReferenceInformation
object
Todo.
14 properties
1 required
MedicationDispense
object
Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) p…
35 properties
1 required
ProjectDefaultProfile
object
Default profiles to apply to resources in this project that do not individually specify profiles
2 properties
2 required
ObservationDefinition_QuantitativeDetails
object
Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.
7 properties
Measure_Group
object
The Measure resource provides the definition of a quality measure.
7 properties
MarketingStatus
object
The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
8 properties
3 required
Claim_Detail
object
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reim…
15 properties
1 required
Annotation
object
A text note which also contains information about who made the statement and when.
6 properties
ActivityDefinition
object
This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
62 properties
1 required
MedicinalProductPharmaceutical
object
A pharmaceutical product described in terms of its composition and dose form.
16 properties
3 required
positiveInt
number
An integer with a value that is positive (e.g. 0)
ExplanationOfBenefit_SubDetail
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
16 properties
1 required
Endpoint
object
The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR ser…
20 properties
3 required
code
string
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
EffectEvidenceSynthesis_ResultsByExposure
object
The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from…
7 properties
1 required
CapabilityStatement_Software
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
6 properties
SubstanceReferenceInformation_GeneElement
object
Todo.
6 properties
Binary
object
A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whe…
8 properties
1 required
SubstanceNucleicAcid_Linkage
object
Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements.…
7 properties
Provenance
object
Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provena…
20 properties
3 required
Library
object
The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as lo…
41 properties
2 required
Immunization
object
Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.
38 properties
3 required
OperationOutcome_Issue
object
A collection of error, warning, or information messages that result from a system action.
9 properties
SubstanceReferenceInformation_Target
object
Todo.
13 properties
ObservationDefinition_QualifiedInterval
object
Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.
11 properties
Provenance_Entity
object
Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provena…
6 properties
1 required
ChargeItemDefinition_Applicability
object
The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ…
6 properties
DocumentManifest_Related
object
A collection of documents compiled for a purpose together with metadata that applies to the collection.
5 properties
CarePlan_Activity
object
Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly lim…
8 properties
Dosage_DoseAndRate
object
Indicates how the medication is/was taken or should be taken by the patient.
9 properties
Consent_Policy
object
A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given…
5 properties
TestReport_Action2
object
A summary of information based on the results of executing a TestScript.
4 properties
1 required
RiskEvidenceSynthesis_Certainty
object
The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combina…
6 properties
Claim_SubDetail
object
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reim…
14 properties
1 required
Contract_Rule
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
5 properties
ImagingStudy_Instance
object
Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instanc…
7 properties
1 required
Basic
object
Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropri…
14 properties
2 required
MeasureReport_Population
object
The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.
6 properties
Encounter_Diagnosis
object
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
6 properties
1 required
Narrative
object
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
4 properties
1 required
StructureMap_Group
object
A Map of relationships between 2 structures that can be used to transform data.
9 properties
2 required
ProjectLink
object
Linked Projects whose contents are made available to this one
1 property
1 required
AuditEvent_Detail
object
A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usa…
6 properties
InsurancePlan_Cost
object
Details of a Health Insurance product/plan provided by an organization.
7 properties
1 required
AuditEvent_Agent
object
A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usa…
14 properties
ProjectSite
object
Web application or web site that is associated with the project.
6 properties
2 required
ValueSet
object
A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[…
27 properties
1 required
ExplanationOfBenefit_SupportingInfo
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
14 properties
1 required
MedicinalProductUndesirableEffect
object
Describe the undesirable effects of the medicinal product.
14 properties
1 required
uri
string
String of characters used to identify a name or a resource
GuidanceResponse
object
A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any…
26 properties
1 required
Age
object
A duration of time during which an organism (or a process) has existed.
7 properties
PlanDefinition
object
This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support…
41 properties
1 required
ClinicalImpression_Finding
object
A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies tha…
6 properties
EventDefinition
object
The EventDefinition resource provides a reusable description of when a particular event can occur.
38 properties
2 required
OperationDefinition_Parameter
object
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
14 properties
uuid
string
A UUID, represented as a URI
MedicinalProductIngredient_SpecifiedSubstance
object
An ingredient of a manufactured item or pharmaceutical product.
7 properties
2 required
Media
object
A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
32 properties
2 required
SubstanceProtein_Subunit
object
A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a define…
11 properties
Encounter_StatusHistory
object
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
5 properties
1 required
MolecularSequence_Repository
object
Raw data describing a biological sequence.
9 properties
Substance_Ingredient
object
A homogeneous material with a definite composition.
6 properties
Location_Position
object
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodat…
6 properties
Contract_Legal
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
5 properties
Contract
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
44 properties
1 required
MedicationStatement
object
A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken…
28 properties
2 required
MedicationKnowledge_Dosage
object
Information about a medication that is used to support knowledge.
5 properties
2 required
ExampleScenario_ContainedInstance
object
Example of workflow instance.
5 properties
ProjectMembershipAccess
object
Extended access configuration using parameterized access policies.
2 properties
1 required
SubstanceSpecification_Representation
object
The detailed description of a substance, typically at a level beyond what is used for prescribing.
6 properties
MedicationKnowledge_MaxDispense
object
Information about a medication that is used to support knowledge.
5 properties
1 required
ResearchSubject
object
A physical entity which is the primary unit of operational and/or administrative interest in a study.
17 properties
3 required
CapabilityStatement_Resource
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
20 properties
ImmunizationRecommendation_DateCriterion
object
A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
5 properties
1 required
CoverageEligibilityRequest_Item
object
The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResp…
13 properties
ExampleScenario_Alternative
object
Example of workflow instance.
6 properties
Claim_Item
object
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reim…
27 properties
1 required
CapabilityStatement_SupportedMessage
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
5 properties
1 required
ExplanationOfBenefit_Insurance
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
6 properties
1 required
ChargeItem
object
The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but contain…
38 properties
3 required
Parameters_Parameter
object
This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RES…
56 properties
ProductShelfLife
object
The shelf-life and storage information for a medicinal product item or container can be described using this class.
7 properties
2 required
CapabilityStatement_Security
object
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual…
6 properties
MolecularSequence_Variant
object
Raw data describing a biological sequence.
9 properties
ResearchStudy_Objective
object
A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This inc…
5 properties
StructureDefinition_Mapping
object
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions an…
7 properties
MedicinalProductPackaged
object
A medicinal product in a container or package.
18 properties
2 required
RelatedPerson
object
Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care pro…
21 properties
2 required
DeviceDefinition_Property
object
The characteristics, operational status and capabilities of a medical-related component of a medical device.
6 properties
1 required
ActivityDefinition_Participant
object
This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
5 properties
CoverageEligibilityRequest_Insurance
object
The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResp…
6 properties
1 required
ClientApplicationLaunchIdentifierSystems
object
Optional array of identifier systems to use in SMART launch context. When specified, the resource's identifier with the matching system will be included in the…
2 properties
2 required
ExplanationOfBenefit_ProcessNote
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
7 properties
ClaimResponse_Insurance
object
This resource provides the adjudication details from the processing of a Claim resource.
8 properties
1 required
Claim_Insurance
object
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reim…
10 properties
1 required
ElementDefinition_Binding
object
Captures constraints on each element within the resource, profile, or extension.
6 properties
TestScript_Metadata
object
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
5 properties
1 required
ImagingStudy_Performer
object
Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instanc…
5 properties
1 required
NutritionOrder_Texture
object
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
5 properties
ValueSet_Compose
object
A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[…
7 properties
1 required
MedicinalProduct_CountryLanguage
object
Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).
6 properties
2 required
MolecularSequence_StructureVariant
object
Raw data describing a biological sequence.
8 properties
BulkDataExportError
object
Array of message file items following the same structure as the output array.
2 properties
2 required
Composition_RelatesTo
object
A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establis…
6 properties
DeviceRequest_Parameter
object
Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.
8 properties
ExplanationOfBenefit_Payment
object
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the s…
9 properties
MolecularSequence_Outer
object
Raw data describing a biological sequence.
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Medplum 3
Other APIs Medplum publishes across the network.
Medplum GraphQL API
Medplum Bots
Medplum Subscriptions
#FHIR
Where this information came from
This is an independent, third-party profile of Medplum Fhir API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.