Namespace fhirCsR2.Models

Classes

Account

A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centres, etc.

AccountStatusCodes

Code Values for the Account.status field

Address

There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world.

Age

There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.

AllergyIntolerance

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

AllergyIntoleranceCategoryCodes

Code Values for the AllergyIntolerance.category field

AllergyIntoleranceCriticalityCodes

Code Values for the AllergyIntolerance.criticality field

AllergyIntoleranceReaction

Details about each adverse reaction event linked to exposure to the identified Substance.

AllergyIntoleranceReactionCertaintyCodes

Code Values for the AllergyIntolerance.reaction.certainty field

AllergyIntoleranceReactionSeverityCodes

Code Values for the AllergyIntolerance.reaction.severity field

AllergyIntoleranceStatusCodes

Code Values for the AllergyIntolerance.status field

AllergyIntoleranceTypeCodes

Code Values for the AllergyIntolerance.type field

Annotation

A text note which also contains information about who made the statement and when.

Appointment

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 Encounter(s).

AppointmentParticipant

List of participants involved in the appointment.

AppointmentParticipantRequiredCodes

Code Values for the Appointment.participant.required field

AppointmentParticipantStatusCodes

Code Values for the Appointment.participant.status field

AppointmentResponse

A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

AppointmentResponseParticipantStatusCodes

Code Values for the AppointmentResponse.participantStatus field

AppointmentStatusCodes

Code Values for the Appointment.status field

Attachment

For referring to data content defined in other formats.

AuditEvent

A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.

AuditEventObject

The event may have other objects involved.

AuditEventObjectDetail

Additional Information about the Object.

AuditEventParticipant

The event has one or more active participants.

AuditEventParticipantNetwork

Logical network location for application activity, if the activity has a network location.

BackboneElement

Base definition for all elements that are defined inside a resource - but not those in a data type.

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 appropriate for inclusion in the FHIR specification.

Binary

A binary resource can contain any content, whether text, image, pdf, zip archive, etc.

BodySite

Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

Bundle

A container for a collection of resources.

BundleEntry

An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).

BundleEntryRequest

Additional information about how this entry should be processed as part of a transaction.

BundleEntryRequestMethodCodes

Code Values for the Bundle.entry.request.method field

BundleEntryResponse

Additional information about how this entry should be processed as part of a transaction.

BundleEntrySearch

Information about the search process that lead to the creation of this entry.

BundleEntrySearchModeCodes

Code Values for the Bundle.entry.search.mode field

BundleLink

A series of links that provide context to this bundle.

BundleTypeCodes

Code Values for the Bundle.type field

CarePlan

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 limited to care for a specific condition or set of conditions.

CarePlanActivity

Allows systems to prompt for performance of planned activities, and validate plans against best practice.

CarePlanActivityDetail

Details in a simple form for generic care plan systems.

CarePlanActivityDetailStatusCodes

Code Values for the CarePlan.activity.detail.status field

CarePlanParticipant

Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.

CarePlanRelatedPlan

Identifies CarePlans with some sort of formal relationship to the current plan.

CarePlanRelatedPlanCodeCodes

Code Values for the CarePlan.relatedPlan.code field

CarePlanStatusCodes

Code Values for the CarePlan.status field

Claim

A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.

ClaimCoverage

Health care programs and insurers are significant payors of health service costs.

ClaimDiagnosis

Ordered list of patient diagnosis for which care is sought.

ClaimItem

First tier of goods and services.

ClaimItemDetail

Second tier of goods and services.

ClaimItemDetailSubDetail

Third tier of goods and services.

ClaimItemProsthesis

The materials and placement date of prior fixed prosthesis.

ClaimMissingTeeth

The list of missing teeth may influence the adjudication of services for example with Bridges.

ClaimPayee

The party to be reimbursed for the services.

ClaimResponse

This resource provides the adjudication details from the processing of a Claim resource.

ClaimResponseAddItem

The first tier service adjudications for payor added services.

ClaimResponseAddItemAdjudication

The adjudications results.

ClaimResponseAddItemDetail

The second tier service adjudications for payor added services.

ClaimResponseAddItemDetailAdjudication

The adjudications results.

ClaimResponseCoverage

Health care programs and insurers are significant payors of health service costs.

ClaimResponseError

Mutually exclusive with Services Provided (Item).

ClaimResponseItem

The first tier service adjudications for submitted services.

ClaimResponseItemAdjudication

The adjudications results.

ClaimResponseItemDetail

The second tier service adjudications for submitted services.

ClaimResponseItemDetailAdjudication

The adjudications results.

ClaimResponseItemDetailSubDetail

The third tier service adjudications for submitted services.

ClaimResponseItemDetailSubDetailAdjudication

The adjudications results.

ClaimResponseNote

Note text.

ClaimResponseOutcomeCodes

Code Values for the ClaimResponse.outcome field

ClaimTypeCodes

Code Values for the Claim.type field

ClaimUseCodes

Code Values for the Claim.use field

ClinicalImpression

A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.

ClinicalImpressionFinding

Specific findings or diagnoses that was considered likely or relevant to ongoing treatment.

ClinicalImpressionInvestigations

One or more sets of investigations (signs, symptions, etc.). The actual grouping of investigations vary greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.

ClinicalImpressionRuledOut

Diagnosis considered not possible.

ClinicalImpressionStatusCodes

Code Values for the ClinicalImpression.status field

CodeableConcept

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Coding

A reference to a code defined by a terminology system.

Communication

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.

CommunicationPayload

Text, attachment(s), or resource(s) that was communicated to the recipient.

CommunicationRequest

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 agency be notified about a reportable condition.

CommunicationRequestPayload

Text, attachment(s), or resource(s) to be communicated to the recipient.

CommunicationRequestStatusCodes

Code Values for the CommunicationRequest.status field

CommunicationStatusCodes

Code Values for the Communication.status field

Composition

A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.

CompositionAttester

Identifies responsibility for the accuracy of the composition content.

CompositionAttesterModeCodes

Code Values for the Composition.attester.mode field

CompositionEvent

Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.

CompositionSection

The root of the sections that make up the composition.

CompositionSectionModeCodes

Code Values for the Composition.section.mode field

CompositionStatusCodes

Code Values for the Composition.status field

ConceptMap

A statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.

ConceptMapContact

Contacts to assist a user in finding and communicating with the publisher.

ConceptMapElement

Mappings for an individual concept in the source to one or more concepts in the target.

ConceptMapElementTarget

A concept from the target value set that this concept maps to.

ConceptMapElementTargetDependsOn

A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.

ConceptMapElementTargetEquivalenceCodes

Code Values for the ConceptMap.element.target.equivalence field

ConceptMapStatusCodes

Code Values for the ConceptMap.status field

Condition

Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a diagnosis during an encounter; populating a problem list or a summary statement, such as a discharge summary.

ConditionClinicalStatusCodes

Code Values for the Condition.clinicalStatus field

ConditionEvidence

Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed.

ConditionStage

Clinical stage or grade of a condition. May include formal severity assessments.

ConditionVerificationStatusCodes

Code Values for the Condition.verificationStatus field

Conformance

A conformance statement is a set of capabilities of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

ConformanceAcceptUnknownCodes

Code Values for the Conformance.acceptUnknown field

ConformanceContact

Contacts to assist a user in finding and communicating with the publisher.

ConformanceDocument

A document definition.

ConformanceDocumentModeCodes

Code Values for the Conformance.document.mode field

ConformanceFormatCodes

Code Values for the Conformance.format field

ConformanceImplementation

Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software program.

ConformanceKindCodes

Code Values for the Conformance.kind field

ConformanceMessaging

A description of the messaging capabilities of the solution.

ConformanceMessagingEndpoint

An endpoint (network accessible address) to which messages and/or replies are to be sent.

ConformanceMessagingEvent

A description of the solution's support for an event at this end-point.

ConformanceMessagingEventCategoryCodes

Code Values for the Conformance.messaging.event.category field

ConformanceMessagingEventModeCodes

Code Values for the Conformance.messaging.event.mode field

ConformanceRest

A definition of the restful capabilities of the solution, if any.

ConformanceRestInteraction

A specification of restful operations supported by the system.

ConformanceRestInteractionCodeCodes

Code Values for the Conformance.rest.interaction.code field

ConformanceRestModeCodes

Code Values for the Conformance.rest.mode field

ConformanceRestOperation

Definition of an operation or a named query and with its parameters and their meaning and type.

ConformanceRestResource

A specification of the restful capabilities of the solution for a specific resource type.

ConformanceRestResourceConditionalDeleteCodes

Code Values for the Conformance.rest.resource.conditionalDelete field

ConformanceRestResourceInteraction

Identifies a restful operation supported by the solution.

ConformanceRestResourceInteractionCodeCodes

Code Values for the Conformance.rest.resource.interaction.code field

ConformanceRestResourceSearchParam

Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.

ConformanceRestResourceSearchParamModifierCodes

Code Values for the Conformance.rest.resource.searchParam.modifier field

ConformanceRestResourceSearchParamTypeCodes

Code Values for the Conformance.rest.resource.searchParam.type field

ConformanceRestResourceVersioningCodes

Code Values for the Conformance.rest.resource.versioning field

ConformanceRestSecurity

Information about security implementation from an interface perspective - what a client needs to know.

ConformanceRestSecurityCertificate

Certificates associated with security profiles.

ConformanceRestTransactionModeCodes

Code Values for the Conformance.rest.transactionMode field

ConformanceSoftware

Software that is covered by this conformance statement. It is used when the conformance statement describes the capabilities of a particular software version, independent of an installation.

ConformanceStatusCodes

Code Values for the Conformance.status field

ContactPoint

Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

ContactPointSystemCodes

Code Values for the ContactPoint.system field

ContactPointUseCodes

Code Values for the ContactPoint.use field

Contract

A formal agreement between parties regarding the conduct of business, exchange of information or other matters.

ContractActor

List of Contract actors.

ContractFriendly

The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.

ContractLegal

List of Legal expressions or representations of this Contract.

ContractRule

List of Computable Policy Rule Language Representations of this Contract.

ContractSigner

Party signing this Contract.

ContractTerm

One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

ContractTermActor

List of actors participating in this Contract Provision.

ContractTermValuedItem

Contract Provision Valued Item List.

ContractValuedItem

Contract Valued Item List.

Count

There SHALL be a code with a value of "1" if there is a value and it SHALL be an expression of length. If system is present, it SHALL be UCUM. If present, the value SHALL a whole number.

Coverage

Financial instrument which may be used to pay for or reimburse health care products and services.

DataElement

The formal description of a single piece of information that can be gathered and reported.

DataElementContact

Contacts to assist a user in finding and communicating with the publisher.

DataElementMapping

Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.

DataElementStatusCodes

Code Values for the DataElement.status field

DataElementStringencyCodes

Code Values for the DataElement.stringency field

DetectedIssue

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, Ineffective treatment frequency, Procedure-condition conflict, etc.

DetectedIssueMitigation

Indicates an action that has been taken or is committed to to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.

DetectedIssueSeverityCodes

Code Values for the DetectedIssue.severity field

Device

This resource identifies an instance of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices includes durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.

DeviceComponent

Describes the characteristics, operational status and capabilities of a medical-related component of a medical device.

DeviceComponentMeasurementPrincipleCodes

Code Values for the DeviceComponent.measurementPrinciple field

DeviceComponentProductionSpecification

Describes the production specification such as component revision, serial number, etc.

DeviceMetric

Describes a measurement, calculation or setting capability of a medical device.

DeviceMetricCalibration

Describes the calibrations that have been performed or that are required to be performed.

DeviceMetricCalibrationStateCodes

Code Values for the DeviceMetric.calibration.state field

DeviceMetricCalibrationTypeCodes

Code Values for the DeviceMetric.calibration.type field

DeviceMetricCategoryCodes

Code Values for the DeviceMetric.category field

DeviceMetricColorCodes

Code Values for the DeviceMetric.color field

DeviceMetricOperationalStatusCodes

Code Values for the DeviceMetric.operationalStatus field

DeviceStatusCodes

Code Values for the Device.status field

DeviceUseRequest

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.

DeviceUseRequestPriorityCodes

Code Values for the DeviceUseRequest.priority field

DeviceUseRequestStatusCodes

Code Values for the DeviceUseRequest.status field

DeviceUseStatement

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.

DiagnosticOrder

A record of a request for a diagnostic investigation service to be performed.

DiagnosticOrderEvent

A summary of the events of interest that have occurred as the request is processed; e.g. when the order was made, various processing steps (specimens received), when it was completed.

DiagnosticOrderEventStatusCodes

Code Values for the DiagnosticOrder.event.status field

DiagnosticOrderItem

The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.

DiagnosticOrderItemStatusCodes

Code Values for the DiagnosticOrder.item.status field

DiagnosticOrderPriorityCodes

Code Values for the DiagnosticOrder.priority field

DiagnosticOrderStatusCodes

Code Values for the DiagnosticOrder.status field

DiagnosticReport

The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.

DiagnosticReportImage

Many diagnostic services include images in the report as part of their service.

DiagnosticReportStatusCodes

Code Values for the DiagnosticReport.status field

Distance

There SHALL be a code if there is a value and it SHALL be an expression of length. If system is present, it SHALL be UCUM.

DocumentManifest

A manifest that defines a set of documents.

DocumentManifestContent

The list of Documents included in the manifest.

DocumentManifestRelated

Related identifiers or resources associated with the DocumentManifest.

DocumentManifestStatusCodes

Code Values for the DocumentManifest.status field

DocumentReference

A reference to a document .

DocumentReferenceContent

The document and format referenced. There may be multiple content element repetitions, each with a different format.

DocumentReferenceContext

The clinical context in which the document was prepared.

DocumentReferenceContextRelated

Related identifiers or resources associated with the DocumentReference.

DocumentReferenceRelatesTo

Relationships that this document has with other document references that already exist.

DocumentReferenceRelatesToCodeCodes

Code Values for the DocumentReference.relatesTo.code field

DocumentReferenceStatusCodes

Code Values for the DocumentReference.status field

DomainResource

A resource that includes narrative, extensions, and contained resources.

Duration

There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.

Element

Base definition for all elements in a resource.

ElementDefinition

Captures constraints on each element within the resource, profile, or extension.

ElementDefinitionBase

Information about the base definition of the element, provided to make it unncessary for tools to trace the deviation of the element through the derived and related profiles. This information is only provided where the element definition represents a constraint on another element definition, and must be present if there is a base element definition.

ElementDefinitionBinding

Binds to a value set if this element is coded (code, Coding, CodeableConcept).

ElementDefinitionBindingStrengthCodes

Code Values for the ElementDefinition.binding.strength field

ElementDefinitionConstraint

Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.

ElementDefinitionConstraintSeverityCodes

Code Values for the ElementDefinition.constraint.severity field

ElementDefinitionMapping

Provides guidance to implementers familiar with or converting content from other specifications.

ElementDefinitionSlicing

Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).

ElementDefinitionSlicingRulesCodes

Code Values for the ElementDefinition.slicing.rules field

ElementDefinitionType

The data type or resource that the value of this element is permitted to be.

ElementDefinitionTypeAggregationCodes

Code Values for the ElementDefinition.type.aggregation field

EligibilityRequest

This resource provides the insurance eligibility details from the insurer regarding a specified coverage and optionally some class of service.

EligibilityResponse

This resource provides eligibility and plan details from the processing of an Eligibility resource.

EligibilityResponseOutcomeCodes

Code Values for the EligibilityResponse.outcome field

Encounter

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.

EncounterClassCodes

Code Values for the Encounter.class field

EncounterHospitalization

Details about the admission to a healthcare service.

EncounterLocation

List of locations where the patient has been during this encounter.

EncounterLocationStatusCodes

Code Values for the Encounter.location.status field

EncounterParticipant

The list of people responsible for providing the service.

EncounterStatusCodes

Code Values for the Encounter.status field

EncounterStatusHistory

The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.

EncounterStatusHistoryStatusCodes

Code Values for the Encounter.statusHistory.status field

EnrollmentRequest

This resource provides the insurance enrollment details to the insurer regarding a specified coverage.

EnrollmentResponse

This resource provides enrollment and plan details from the processing of an Enrollment resource.

EnrollmentResponseOutcomeCodes

Code Values for the EnrollmentResponse.outcome field

EpisodeOfCare

An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.

EpisodeOfCareCareTeam

The list of practitioners that may be facilitating this episode of care for specific purposes.

EpisodeOfCareStatusCodes

Code Values for the EpisodeOfCare.status field

EpisodeOfCareStatusHistory

The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).

EpisodeOfCareStatusHistoryStatusCodes

Code Values for the EpisodeOfCare.statusHistory.status field

ExplanationOfBenefit

This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.

ExplanationOfBenefitOutcomeCodes

Code Values for the ExplanationOfBenefit.outcome field

Extension

Optional Extensions Element - found in all resources.

FamilyMemberHistory

Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.

FamilyMemberHistoryCondition

The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

FamilyMemberHistoryGenderCodes

Code Values for the FamilyMemberHistory.gender field

FamilyMemberHistoryStatusCodes

Code Values for the FamilyMemberHistory.status field

Flag

Prospective warnings of potential issues when providing care to the patient.

FlagStatusCodes

Code Values for the Flag.status field

Goal

Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

GoalOutcome

Outcome tracking is a key aspect of care planning.

GoalStatusCodes

Code Values for the Goal.status field

Group

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 formally or legally recognized; i.e. a collection of entities that isn't an Organization.

GroupCharacteristic

Needs to be a generic mechanism for identifying what individuals can be part of a group.

GroupMember

Often the only thing of interest about a group is "who's in it".

GroupTypeCodes

Code Values for the Group.type field

HealthcareService

The details of a healthcare service available at a location.

HealthcareServiceAvailableTime

A collection of times that the Service Site is available.

HealthcareServiceAvailableTimeDaysOfWeekCodes

Code Values for the HealthcareService.availableTime.daysOfWeek field

HealthcareServiceNotAvailable

The HealthcareService is not available during this period of time due to the provided reason.

HealthcareServiceServiceType

A specific type of service that may be delivered or performed.

HumanName

A human's name with the ability to identify parts and usage.

HumanNameUseCodes

Code Values for the HumanName.use field

Identifier

A technical identifier - identifies some entity uniquely and unambiguously.

IdentifierUseCodes

Code Values for the Identifier.use field

ImagingObjectSelection

A manifest of a set of DICOM Service-Object Pair Instances (SOP Instances). The referenced SOP Instances (images or other content) are for a single patient, and may be from one or more studies. The referenced SOP Instances have been selected for a purpose, such as quality assurance, conference, or consult. Reflecting that range of purposes, typical ImagingObjectSelection resources may include all SOP Instances in a study (perhaps for sharing through a Health Information Exchange); key images from multiple studies (for reference by a referring or treating physician); a multi-frame ultrasound instance ("cine" video clip) and a set of measurements taken from that instance (for inclusion in a teaching file); and so on.

ImagingObjectSelectionStudy

DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the study level provide a means of retrieving the entire study.

ImagingObjectSelectionStudySeries

DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the series level provide a means of retrieving the entire series.

ImagingObjectSelectionStudySeriesInstance

DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. This is the instance level identity of the instance in the selection.

ImagingObjectSelectionStudySeriesInstanceFrames

The specific set of frames referenced in this imaging object selection. The URL retrieves the pixel data, and is encapsulated in a multipart MIME response.

ImagingStudy

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 Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

ImagingStudyAvailabilityCodes

Code Values for the ImagingStudy.availability field

ImagingStudySeries

Each study has one or more series of images or other content.

ImagingStudySeriesAvailabilityCodes

Code Values for the ImagingStudy.series.availability field

ImagingStudySeriesInstance

A single SOP Instance within the series, e.g. an image, or presentation state.

Immunization

Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.

ImmunizationExplanation

Reasons why a vaccine was or was not administered.

ImmunizationReaction

Categorical data indicating that an adverse event is associated in time to an immunization.

ImmunizationRecommendation

A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.

ImmunizationRecommendationRecommendation

Vaccine administration recommendations.

ImmunizationRecommendationRecommendationDateCriterion

Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.

ImmunizationRecommendationRecommendationProtocol

Contains information about the protocol under which the vaccine was administered.

ImmunizationStatusCodes

Code Values for the Immunization.status field

ImmunizationVaccinationProtocol

Contains information about the protocol(s) under which the vaccine was administered.

ImplementationGuide

A set of rules or how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole, and to publish a computable definition of all the parts.

ImplementationGuideContact

Contacts to assist a user in finding and communicating with the publisher.

ImplementationGuideDependency

Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

ImplementationGuideDependencyTypeCodes

Code Values for the ImplementationGuide.dependency.type field

ImplementationGuideGlobal

A set of profiles that all resources covered by this implementation guide must conform to.

ImplementationGuidePackage

A logical group of resources. Logical groups can be used when building pages.

ImplementationGuidePackageResource

A resource that is part of the implementation guide. Conformance resources (value set, structure definition, conformance statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.

ImplementationGuidePackageResourcePurposeCodes

Code Values for the ImplementationGuide.package.resource.purpose field

ImplementationGuidePage

A page / section in the implementation guide. The root page is the implementation guide home page.

ImplementationGuidePageKindCodes

Code Values for the ImplementationGuide.page.kind field

ImplementationGuideStatusCodes

Code Values for the ImplementationGuide.status field

List

A set of information summarized from a list of other resources.

ListEntry

Entries in this list.

ListModeCodes

Code Values for the List.mode field

ListStatusCodes

Code Values for the List.status field

Location

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.

LocationModeCodes

Code Values for the Location.mode field

LocationPosition

For mobile applications and automated route-finding knowing the exact location of the Location is required.

LocationStatusCodes

Code Values for the Location.status field

Media

A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

MediaTypeCodes

Code Values for the Media.type field

Medication

This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.

MedicationAdministration

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 running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.

MedicationAdministrationDosage

Describes the medication dosage information details e.g. dose, rate, site, route, etc.

MedicationAdministrationStatusCodes

Code Values for the MedicationAdministration.status field

MedicationDispense

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) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

MedicationDispenseDosageInstruction

Indicates how the medication is to be used by the patient.

MedicationDispenseStatusCodes

Code Values for the MedicationDispense.status field

MedicationDispenseSubstitution

Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why.

MedicationOrder

An order for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationOrder" rather than "MedicationPrescription" to generalize the use across inpatient and outpatient settings as well as for care plans, etc.

MedicationOrderDispenseRequest

Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription). Note that this information is NOT always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.

MedicationOrderDosageInstruction

Indicates how the medication is to be used by the patient.

MedicationOrderStatusCodes

Code Values for the MedicationOrder.status field

MedicationOrderSubstitution

Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.

MedicationPackage

Information that only applies to packages (not products).

MedicationPackageContent

A set of components that go to make up the described item.

MedicationProduct

Information that only applies to products (not packages).

MedicationProductBatch

Information about a group of medication produced or packaged from one production run.

MedicationProductIngredient

Identifies a particular constituent of interest in the product.

MedicationStatement

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 the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from e.g. the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.

MedicationStatementDosage

Indicates how the medication is/was used by the patient.

MedicationStatementStatusCodes

Code Values for the MedicationStatement.status field

MessageHeader

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 information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

MessageHeaderDestination

Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".

MessageHeaderResponse

Information about the message that this message is a response to. Only present if this message is a response.

MessageHeaderResponseCodeCodes

Code Values for the MessageHeader.response.code field

MessageHeaderSource

Allows replies, supports audit.

Money

There SHALL be a code if there is a value and it SHALL be an expression of currency. If system is present, it SHALL be ISO 4217 (system = "urn:iso:std:iso:4217" - currency).

NamingSystem

A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.

NamingSystemContact

Contacts to assist a user in finding and communicating with the publisher.

NamingSystemKindCodes

Code Values for the NamingSystem.kind field

NamingSystemStatusCodes

Code Values for the NamingSystem.status field

NamingSystemUniqueId

Indicates how the system may be identified when referenced in electronic exchange.

NamingSystemUniqueIdTypeCodes

Code Values for the NamingSystem.uniqueId.type field

Narrative

A human-readable formatted text, including images.

NarrativeStatusCodes

Code Values for the Narrative.status field

NutritionOrder

A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

NutritionOrderEnteralFormula

Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

NutritionOrderEnteralFormulaAdministration

Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.

NutritionOrderOralDiet

Diet given orally in contrast to enteral (tube) feeding.

NutritionOrderOralDietNutrient

Class that defines the quantity and type of nutrient modifications required for the oral diet.

NutritionOrderOralDietTexture

Class that describes any texture modifications required for the patient to safely consume various types of solid foods.

NutritionOrderStatusCodes

Code Values for the NutritionOrder.status field

NutritionOrderSupplement

Oral nutritional products given in order to add further nutritional value to the patient's diet.

Observation

Measurements and simple assertions made about a patient, device or other subject.

ObservationComponent

Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.

ObservationReferenceRange

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

ObservationRelated

Normally, an observation will have either a value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and a set of related observations or sometimes QuestionnaireResponse from which the measure is derived.

ObservationRelatedTypeCodes

Code Values for the Observation.related.type field

ObservationStatusCodes

Code Values for the Observation.status field

OperationDefinition

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

OperationDefinitionContact

Contacts to assist a user in finding and communicating with the publisher.

OperationDefinitionKindCodes

Code Values for the OperationDefinition.kind field

OperationDefinitionParameter

The parameters for the operation/query.

OperationDefinitionParameterBinding

Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).

OperationDefinitionParameterBindingStrengthCodes

Code Values for the OperationDefinition.parameter.binding.strength field

OperationDefinitionParameterUseCodes

Code Values for the OperationDefinition.parameter.use field

OperationDefinitionStatusCodes

Code Values for the OperationDefinition.status field

OperationOutcome

A collection of error, warning or information messages that result from a system action.

OperationOutcomeIssue

An error, warning or information message that results from a system action.

OperationOutcomeIssueSeverityCodes

Code Values for the OperationOutcome.issue.severity field

Order

A request to perform an action.

OrderResponse

A response to an order.

OrderResponseOrderStatusCodes

Code Values for the OrderResponse.orderStatus field

OrderWhen

When order should be fulfilled.

Organization

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.

OrganizationContact

Need to keep track of assigned contact points within bigger organization.

Parameters

This special resource type is used to represent an operation request and response (operations.html). It has no other use, and there is no RESTful endpoint associated with it.

ParametersParameter

A parameter passed to or received from the operation.

Patient

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

PatientAnimal

Many clinical systems are extended to care for animal patients as well as human.

PatientCommunication

If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.

PatientContact

Need to track people you can contact about the patient.

PatientContactGenderCodes

Code Values for the Patient.contact.gender field

PatientGenderCodes

Code Values for the Patient.gender field

PatientLink

There are multiple usecases: * Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.

PatientLinkTypeCodes

Code Values for the Patient.link.type field

PaymentNotice

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

PaymentReconciliation

This resource provides payment details and claim references supporting a bulk payment.

PaymentReconciliationDetail

List of individual settlement amounts and the corresponding transaction.

PaymentReconciliationNote

Suite of notes.

PaymentReconciliationOutcomeCodes

Code Values for the PaymentReconciliation.outcome field

Period

A time period defined by a start and end date and optionally time.

Person

Demographics and administrative information about a person independent of a specific health-related context.

PersonGenderCodes

Code Values for the Person.gender field

PersonLink

Link to a resource that concerns the same actual person.

PersonLinkAssuranceCodes

Code Values for the Person.link.assurance field

Practitioner

A person who is directly or indirectly involved in the provisioning of healthcare.

PractitionerGenderCodes

Code Values for the Practitioner.gender field

PractitionerPractitionerRole

The list of roles/organizations that the practitioner is associated with.

PractitionerQualification

Qualifications obtained by training and certification.

Procedure

An action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.

ProcedureFocalDevice

A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

ProcedurePerformer

Limited to 'real' people rather than equipment.

ProcedureRequest

A request for a procedure to be performed. May be a proposal or an order.

ProcedureRequestPriorityCodes

Code Values for the ProcedureRequest.priority field

ProcedureRequestStatusCodes

Code Values for the ProcedureRequest.status field

ProcedureStatusCodes

Code Values for the Procedure.status field

ProcessRequest

This resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.

ProcessRequestActionCodes

Code Values for the ProcessRequest.action field

ProcessRequestItem

List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.

ProcessResponse

This resource provides processing status, errors and notes from the processing of a resource.

ProcessResponseNotes

Suite of processing note or additional requirements is the processing has been held.

Provenance

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

ProvenanceAgent

An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, an organization, software, or other entities that may be ascribed responsibility.

ProvenanceAgentRelatedAgent

A relationship between two the agents referenced in this resource. This is defined to allow for explicit description of the delegation between agents. For example, this human author used this device, or one person acted on another's behest.

ProvenanceEntity

An entity used in this activity.

ProvenanceEntityRoleCodes

Code Values for the Provenance.entity.role field

Quantity

A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

QuantityComparatorCodes

Code Values for the Quantity.comparator field

Questionnaire

A structured set of questions intended to guide the collection of answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.

QuestionnaireGroup

Need to be able to logically group answers to grouped questions.

QuestionnaireGroupQuestion

Must register answers to questions.

QuestionnaireGroupQuestionTypeCodes

Code Values for the Questionnaire.group.question.type field

QuestionnaireResponse

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 the underlying questions.

QuestionnaireResponseGroup

Need to be able to logically group answers to grouped questions.

QuestionnaireResponseGroupQuestion

Must register answers to questions.

QuestionnaireResponseGroupQuestionAnswer

The respondent's answer(s) to the question.

QuestionnaireResponseStatusCodes

Code Values for the QuestionnaireResponse.status field

QuestionnaireStatusCodes

Code Values for the Questionnaire.status field

Range

A set of ordered Quantities defined by a low and high limit.

Ratio

A relationship of two Quantity values - expressed as a numerator and a denominator.

Reference

A reference from one resource to another.

ReferralRequest

Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.

ReferralRequestStatusCodes

Code Values for the ReferralRequest.status field

RelatedPerson

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 process.

RelatedPersonGenderCodes

Code Values for the RelatedPerson.gender field

Resource

This is the base resource type for everything.

RiskAssessment

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

RiskAssessmentPrediction

Describes the expected outcome for the subject.

SampledData

A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.

Schedule

A container for slot(s) of time that may be available for booking appointments.

SearchParameter

A search parameter that defines a named search item that can be used to search/filter on a resource.

SearchParameterContact

Contacts to assist a user in finding and communicating with the publisher.

SearchParameterStatusCodes

Code Values for the SearchParameter.status field

SearchParameterTypeCodes

Code Values for the SearchParameter.type field

SearchParameterXpathUsageCodes

Code Values for the SearchParameter.xpathUsage field

Signature

A digital signature along with supporting context. The signature may be electronic/cryptographic in nature, or a graphical image representing a hand-written signature, or a signature process. Different Signature approaches have different utilities.

SimpleQuantity

The comparator is not used on a SimpleQuantity

Slot

A slot of time on a schedule that may be available for booking appointments.

SlotFreeBusyTypeCodes

Code Values for the Slot.freeBusyType field

Specimen

A sample to be used for analysis.

SpecimenCollection

Details concerning the specimen collection.

SpecimenContainer

The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

SpecimenStatusCodes

Code Values for the Specimen.status field

SpecimenTreatment

Details concerning treatment and processing steps for the specimen.

StructureDefinition

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, and constraints on resources and data types.

StructureDefinitionContact

Contacts to assist a user in finding and communicating with the publisher.

StructureDefinitionContextTypeCodes

Code Values for the StructureDefinition.contextType field

StructureDefinitionDifferential

A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.

StructureDefinitionKindCodes

Code Values for the StructureDefinition.kind field

StructureDefinitionMapping

An external specification that the content is mapped to.

StructureDefinitionSnapshot

A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.

StructureDefinitionStatusCodes

Code Values for the StructureDefinition.status field

Subscription

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 server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system is able to take an appropriate action.

SubscriptionChannel

Details where to send notifications when resources are received that meet the criteria.

SubscriptionChannelTypeCodes

Code Values for the Subscription.channel.type field

SubscriptionStatusCodes

Code Values for the Subscription.status field

Substance

A homogeneous material with a definite composition.

SubstanceIngredient

A substance can be composed of other substances.

SubstanceInstance

Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.

SupplyDelivery

Record of delivery of what is supplied.

SupplyDeliveryStatusCodes

Code Values for the SupplyDelivery.status field

SupplyRequest

A record of a request for a medication, substance or device used in the healthcare setting.

SupplyRequestStatusCodes

Code Values for the SupplyRequest.status field

SupplyRequestWhen

When the request should be fulfilled.

TestScript

TestScript is a resource that specifies a suite of tests against a FHIR server implementation to determine compliance against the FHIR specification.

TestScriptContact

Contacts to assist a user in finding and communicating with the publisher.

TestScriptFixture

Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.

TestScriptMetadata

The required capability must exist and are assumed to function correctly on the FHIR server being tested.

TestScriptMetadataCapability

Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.

TestScriptMetadataLink

A link to the FHIR specification that this test is covering.

TestScriptSetup

A series of required setup operations before tests are executed.

TestScriptSetupAction

Action would contain either an operation or an assertion.

TestScriptSetupActionAssert

Evaluates the results of previous operations to determine if the server under test behaves appropriately.

TestScriptSetupActionAssertContentTypeCodes

Code Values for the TestScript.setup.action.assert.contentType field

TestScriptSetupActionAssertDirectionCodes

Code Values for the TestScript.setup.action.assert.direction field

TestScriptSetupActionAssertOperatorCodes

Code Values for the TestScript.setup.action.assert.operator field

TestScriptSetupActionAssertResponseCodes

Code Values for the TestScript.setup.action.assert.response field

TestScriptSetupActionOperation

The operation to perform.

TestScriptSetupActionOperationAcceptCodes

Code Values for the TestScript.setup.action.operation.accept field

TestScriptSetupActionOperationContentTypeCodes

Code Values for the TestScript.setup.action.operation.contentType field

TestScriptSetupActionOperationRequestHeader

Header elements would be used to set HTTP headers.

TestScriptStatusCodes

Code Values for the TestScript.status field

TestScriptTeardown

A series of operations required to clean up after the all the tests are executed (successfully or otherwise).

TestScriptTeardownAction

The teardown action will only contain an operation.

TestScriptTest

A test in this script.

TestScriptTestAction

Action would contain either an operation or an assertion.

TestScriptVariable

Variable is set based either on element value in response body or on header field value in the response headers.

Timing

Specifies an event that may occur multiple times. Timing schedules are used to record when things are expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds.