StructureDefinition

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:

Retrieve by id

List an individual StructureDefinition by its id:

GET /StructureDefinition/:id

Implementation Notes

Authorization Types

Authorization is not required.

Headers

Accept: application/fhir+json

Example

Request

GET https://fhir-ehr.cerner.com/r4/StructureDefinition/account-balance

Response

Status: 200 OK
{
  "resourceType": "StructureDefinition",
  "id": "account-balance",
  "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/account-balance",
  "name": "AccountBalance",
  "title": "Account Balance",
  "status": "active",
  "date": "2019-08-13",
  "publisher": "Cerner",
  "description": "Represents the sum of all credits and all debits associated with the account. May be positive, zero or negative.",
  "fhirVersion": "4.0.0",
  "kind": "complex-type",
  "abstract": false,
  "type": "Extension",
  "context": [
    {
      "type": "element",
      "expression": "Account"
    }
  ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
  "snapshot": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "Represents the account balance",
        "definition": "Represents the sum of all credits and all debits associated with the account. May be positive, zero or negative.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ]
      },
      {
        "id": "Extension.id",
        "path": "Extension.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "id"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "sliceName": "extension",
        "short": "Extension",
        "definition": "An Extension",
        "min": 0,
        "max": "0",
        "base": {
          "path": "Extension.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ]
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "representation": [
          "xmlAttr"
        ],
        "short": "identifies the meaning of the extension",
        "definition": "Source of the definition for the extension code - a logical name or a URL.",
        "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific.  This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "uri"
          }
        ],
        "fixedUri": "https://fhir-ehr.cerner.com/r4/StructureDefinition/account-balance"
      },
      {
        "id": "Extension.valueMoney",
        "path": "Extension.valueMoney",
        "short": "Value of extension",
        "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Money"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "Represents the account balance",
        "definition": "Represents the sum of all credits and all debits associated with the account. May be positive, zero or negative.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "sliceName": "extension",
        "max": "0"
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "type": [
          {
            "code": "uri"
          }
        ],
        "fixedUri": "https://fhir-ehr.cerner.com/r4/StructureDefinition/account-balance"
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "min": 1,
        "type": [
          {
            "code": "Money"
          }
        ]
      }
    ]
  }
}

List of StructureDefinitions

ID Description
account-balance Represents the account balance.
account-presented-form 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 within the billing or correspondence workflow.
bill-code-schedule A defined group of bill codes that drives billing behavior.
choice-answer Indicates answers come from a list of options.
client-instruction Represents 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 Indication of a condition’s progress since diagnosis.
condition-lifecycle-status Indication of whether a condition is active, inactive, resolved, etc.
condition-result Indication of the presence (positive) or absence (negative) of a given condition.
coverage-encounter Reference to the Encounter associated to the encounter level Coverage.
communication-preference Defines communication methods preferred by a patient.
custom-attribute A client defined custom attribute for the resource.
description A description providing additional details of the resource.
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 no estimated amount is collected for the encounter.
financial-transaction-account-number A value associated to 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 Client defined value to represent the combination of the type, subtype, and reason describing the financial transaction.
financial-transaction-allocation Defines how the payment or adjustment is to be allocated across other resources.
financial-transaction-amount The total amount of the financial transaction.
financial-transaction-card-brand Identifies the brand of credit card when credit card is used as a payment method.
financial-transaction-date Represents the expiration date if method is card, check date if method is check, EFT date if method is EFT or Lockbox date if method is lockbox.
financial-transaction-location Client configured value representing the location or workflow that the payment was received in.
financial-transaction-method Describes 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 Link to the formatted text for a note. It is used in cases when the note is not a plain text.
infuse-over-time The length of time in minutes it took to infuse a medication.
is-modifiable Indication of whether data is modifiable or not.
is-physician Indication of whether the provider is a physician or not.
military-service-connected-indicator Identifies 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 within the resource along with author and date/time information.
note-allowed Indication of whether an additional comment is permitted.
note-type Describes the type of note represented. This can be useful when there are multiple notes.
offset-by Indicates a resource that this resource is offset by. This resource is no longer active when offset.
patient-adopted 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/time.
pharmacy-verification-status Represents whether a MedicationRequest has been verified by a pharmacist.
precision Indication of the precision of a given value.
priority The priority of the element within a list.
procedure-code A code providing information about the procedure performed on the patient associated to the resource.
quantity-conversion-factor The conversion factor used to calculate the quantity for billing.
related-person-encounter Reference to the Encounter associated to the encounter level RelatedPerson.
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.
revenue-code The type of revenue or cost center providing the product and/or service.
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.