Millennium

StructureDefinition

Overview

The StructureDefinition resource describes a FHIR structure including data elements and their usage. This resource is used to define custom extensions.

The following fields are returned if valued:

Retrieve by ID

List an individual structure definition by its ID.

GET /StructureDefinition/:id

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,
  "context": [
    {
      "type": "element",
      "expression": "Account"
    }
  ],
  "type": "Extension",
  "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 Structure Definitions

ID Description
account-balance The account balance.
account-presented-form The link to the PDF statement image related to the statement account.
account-related-parts The reference to other related accounts.
account-state The status of the account in the billing or correspondence workflow.
bill-code-schedule The defined group of bill codes that drives billing behavior.
choice-answer The indication that answers come from a list of options.
client-instruction The 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 The indication of a condition’s progress since diagnosis.
condition-lifecycle-status The indication of whether a condition is active, inactive, resolved, and so on.
condition-result The indication of the presence (positive) or absence (negative) of a given condition.
converted-measurement The converted measurement of a different measurement system than the original quantity.
coverage-encounter The encounter associated with the encounter-level coverage.
communication-preference The communication methods preferred by a patient.
custom-attribute The client-defined custom attribute for the resource.
description The 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 The 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 the lockbox number.
financial-transaction-alias The client-defined value to represent the combination of the type, subtype, and reason describing the financial transaction.
financial-transaction-allocation The indication 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-card-brand The brand of credit card when a credit card is used as a payment method.
financial-transaction-date 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 The client-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 The link to the formatted text for a note. This link is used when the note is not in plain text.
infuse-over-time The length of time in minutes to infuse a medication.
is-modifiable The indication of whether data is modifiable.
is-physician The indication of whether the provider is a physician.
military-service-connected-indicator The indication of whether an encounter is connected to military service.
modifier-code The 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 The additional details related to an element in the resource with author and date and time information.
note-allowed The indication of whether an additional comment is permitted.
note-type The type of note represented. Note type can be useful when multiple notes exist.
offset-by The indication of another resource that offets this resource. This resource is no longer active when offset.
patient-adopted The indication of whether a patient is adopted.
patient-friendly-display The display name suitable for patient viewing.
payment-collection-status The status of the payment collection for the encounter.
performing-location The location where the resource was performed.
period The time period defined by a start and end date and time.
pharmacy-verification-status The indication of whether a medication request is verified by a pharmacist.
precision The indication of the precision of a given value.
priority The priority of the element in a list.
procedure-code The 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 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 to another resource that must be used in lieu of the resource that contains this link.
replacing The reference to a resource that this resource is replacing.
reply-to The link to a resource that the reply should be directed to.
revenue-code The type of revenue or cost center providing the product, service, or both.
transmitting-organization The 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.