StructureDefinition REST Endpoints

Sort by

Task Path Method

Description

StructureDefinition

This topic describes information for the StructureDefinition resource.

Overview

The StructureDefinition resource describes a FHIR structure including data elements and their usage. Our current implementation uses this resource to define custom extensions.

The following fields are returned if valued:

• Id
• URL
• Name
• Title
• Status
• Date
• Publisher
• Description
• Fhir version
• Kind
• Abstract
• Type
• Context
• Base definition
• Snapshot
• Differential

List of Structure Definitions

ID	Description
account-balance	A representation of the account balance.
account-presented-form	A link to the PDF statement image related to the statement account.
account-related-parts	A reference to other related accounts.
account-state	The status of the account in the billing or correspondence workflow.
action-comment	The comment associated with the action performed on the resource.
apply-first-in-first-out	An indication of whether to apply FIFO logic for recurring encounters.
associated-encounter	A reference to the encounter associated with the resource.
bill-code-schedule	A defined group of bill codes that drives billing behavior.
choice-answer	An indication that answers come from a list of options.
client-instruction	A representation of instructions for an order that are intended for healthcare providers.
client-organization	The financially responsible organization.
clinical-instruction	The clinical instructions for an order that are intended for healthcare providers.
condition-course	An indication of a condition's progress since diagnosis.
condition-lifecycle-status	An indication of whether a condition is active, inactive, resolved, and so on.
condition-result	An indication of the presence (positive) or absence (negative) of a given condition.
converted-measurement	A converted measurement of a different measurement system than the original quantity.
coverage-encounter	A reference to the encounter associated with the encounter-level coverage.
communication-preference	The defined communication methods preferred by a patient.
custom-attribute	A customer-defined custom attribute for the resource.
description	A description providing additional details of the resource.
diagnosis-type	A representation of the type of diagnosis.
email-status	The status of the electronic communication.
estimated-financial-responsibility-amount	The estimated amount to be collected for the encounter.
estimated-financial-responsibility-not-collected-reason	The reason that no estimated amount is collected for the encounter.
familymemberhistory-severity	A qualification of the seriousness or impact on health of the family member condition.
financial-transaction-account-number	A value associated with the specific payment method usually represented as the last four digits of a credit card, the check number, the EFT number, or Lockbox number.
financial-transaction-alias	A customer-defined value to represent the combination of the type, subtype, and reason describing the financial transaction.
financial-transaction-allocation	A definition of how the payment or adjustment is to be allocated across other resources.
financial-transaction-amount	The total amount of the financial transaction.
financial_transaction_authorization_code	An alphanumeric string representing the approval of a credit card transaction.
financial-transaction-card-brand	The brand of credit card when a credit card is used as a payment method.
financial-transaction-date	A representation of the expiration date if the method is card, check date if the method is check, EFT date if the method is EFT, or Lockbox date if the method is Lockbox.
financial-transaction-location	A customer-configured value representing the location or workflow that the payment was received in.
financial-transaction-method	The method of payment for the financial transaction.
financial-transaction-tendered-amount	The amount of cash originally tendered for payment. This value should be greater than or equal to the amount of the cash payment.
financial-transaction-type	The classification of the transaction.
formatted-text	A link to the formatted text for a note. This link is used in cases when the note is not in plain text.
general-resource	A representation of information for appointments scheduled with a resource classified as general.
group-appointment-id	The ID of the appointment group that this appointment is part of.
infuse-over-time	The length of time in minutes it took to infuse a medication.
is-modifiable	An indication of whether data is modifiable.
is-physician	An indication of whether the provider is a physician.
is-reschedulable	An indication of whether the resource can be rescheduled.
military-service-connected-indicator	An indication of whether an encounter is connected to military service.
modifier-code	A code providing additional detail about a product or service.
national-drug-product	The national drug product used in care.
net-price	The quantity times the unit price for a resource total price.
note	Additional details related to an element in the resource with author and date and time information.
note-allowed	An indication of whether an additional comment is permitted.
note-type	The type of note represented. This information can be useful when multiple notes exist.
offset-by	An indication of a resource that this resource is offset by. This resource is no longer active when offset.
patient-adopted	An indication of whether a patient is adopted.
patient-friendly-display	An expression of the original string in terminology that patients should be able to understand.
payment-collection-status	The status of the payment collection for the encounter.
performing-location	A location where the resource was performed.
period	A time period defined by a start and end date and time.
pharmacy-verification-status	A representation of whether a medication request is verified by a pharmacist.
precision	An indication of the precision of a given value.
priority	The priority of the element in a list.
procedure-code	A code providing information about the procedure performed on the patient associated with the resource.
quantity-conversion-factor	The conversion factor used to calculate the quantity for billing.
related-person-encounter	A reference to the encounter associated with the encounter-level related person.
relation	The related person's familial relationship to the patient.
relationship-level	The resource's relationship to either the patient or encounter level.
replaced-by	The resource containing this link must no longer be used. The link points forward to another resource that must be used in lieu of the resource that contains this link.
replacing	A reference to a resource that this resource is replacing.
reply-to	A link to a resource that the reply should be directed to.
reschedule_reason	The reason associated with a rescheduled appointment.
revenue-code	The type of revenue or cost center providing the product, service, or both.
scheduling-location	A reference to the location corresponding with this schedule where the appointment can be booked.
transmitting-organization	An organization that transmitted or participated in the creation of a resource, but not the author.
unit-price	The price of a single unit for the resource.

StructureDefinition

The operations from the StructureDefinition category.

Get a structure definition by ID

Method: get

Path: /StructureDefinition/{ID}