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:
- Id
- Publisher
- Snapshot
- Date
- Fhir version
- Constrained type
- Description
- Status
- Context type
- Context
- URL
- Kind
- Differential
- Abstract
- Base
- Name
Retrieve by id
List an individual StructureDefinition by its id:
GET /StructureDefinition/:id
Implementation Notes
- Authentication is not required to access the StructureDefinition resource
-
This resource can be retrieved by its defining URL or from the StructureDefinition resource located at the service root URL. For example, both of these URLs work:
https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display
https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/StructureDefinition/patient-friendly-display
Authorization Types
Authorization is not required.
Headers
Accept: application/json+fhir
Example
Request
GET https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display
Response
Status: 200 OK
{
"resourceType": "StructureDefinition",
"id": "patient-friendly-display",
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display",
"name": "Patient-Friendly Display",
"status": "draft",
"publisher": "Cerner",
"date": "2016-12-13",
"description": "An expression of the original string in terminology that patients should be able to understand",
"fhirVersion": "1.0.2",
"kind": "datatype",
"constrainedType": "Extension",
"abstract": false,
"contextType": "datatype",
"context": [
"string"
],
"base": "http://hl7.org/fhir/StructureDefinition/Extension",
"snapshot": {
"element": [
{
"path": "Extension",
"short": "String equivalent with patient-friendly terminology",
"definition": "An expression of the original string in terminology that patients should be able to understand",
"min": 0,
"max": "1",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"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"
}
]
},
{
"path": "Extension.extension",
"name": "extension",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"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.",
"comments": "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/dstu2/StructureDefinition/patient-friendly-display"
},
{
"path": "Extension.valueString",
"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": "string"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Extension",
"short": "String equivalent with patient-friendly terminology",
"definition": "An expression of the original string in terminology that patients should be able to understand",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Extension.extension",
"name": "extension",
"max": "0"
},
{
"path": "Extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display"
},
{
"path": "Extension.value[x]",
"min": 1,
"type": [
{
"code": "string"
}
]
}
]
}
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
List of StructureDefinitions
ID | Description |
---|---|
patient-friendly-display |
Display string suitable for patient viewing. |
scheduling-location |
Reference to the location of an appointment being scheduled. |
medication-statement-category |
Category of an order. |
infuse-over-time |
The length of time in minutes it took to infuse a medication. |
encounter-guarantor |
The guarantors of an encounter. Contains a reference to a Patient, Person, or Organization and a period when the guarantor is effective. |