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.
Endpoints
dev
https://api.sandbox.ovok.com/fhir/R5/StructureDefinition| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R5/StructureDefinition/[id] |
| Vread | GET | /fhir/R5/StructureDefinition/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/StructureDefinition/[id] |
| Patch | PATCH | /fhir/R5/StructureDefinition/[id] |
| Delete | DELETE | /fhir/R5/StructureDefinition/[id] |
| Create | POST | /fhir/R5/StructureDefinition |
| Search | GET | /fhir/R5/StructureDefinition?... |
| History | GET | /fhir/R5/StructureDefinition/[id]/_history |
| Type-history | GET | /fhir/R5/StructureDefinition/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
url | uri | 1..1 | Canonical identifier for this structure definition, represented as a URI (globally unique) |
identifier | Identifier | 0..* | Additional identifier for the structure definition |
version | string | 0..1 | Business version of the structure definition |
versionAlgorithm[x] | string / Coding | 0..1 | How to compare versions |
name | string | 1..1 | Name for this structure definition (computer friendly) |
title | string | 0..1 | Name for this structure definition (human friendly) |
status | code | 1..1 | draft |
experimental | boolean | 0..1 | For testing purposes, not real usage |
date | dateTime | 0..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher/steward (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
description | markdown | 0..1 | Natural language description of the structure definition |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for structure definition (if applicable) |
purpose | markdown | 0..1 | Why this structure definition is defined |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
copyrightLabel | string | 0..1 | Copyright holder and year(s) |
keyword | Coding | 0..* | Assist with indexing and finding |
fhirVersion | code | 0..1 | FHIR Version this StructureDefinition targets |
mapping | BackboneElement | 0..* | External specification that the content is mapped to |
kind | code | 1..1 | primitive-type |
abstract | boolean | 1..1 | Whether the structure is abstract |
context | BackboneElement | 0..* | If an extension, where it can be used in instances |
contextInvariant | string | 0..* | FHIRPath invariants - when the extension can be used |
type | uri | 1..1 | Type defined or constrained by this structure |
baseDefinition | canonical | 0..1 | Definition that this type is constrained/specialized from |
derivation | code | 0..1 | specialization |
snapshot | BackboneElement | 0..1 | Snapshot view of the structure |
differential | BackboneElement | 0..1 | Differential view of the structure |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
abstract | token | Whether the structure is abstract |
base | reference | Definition that this type is constrained/specialized from |
base-path | token | Path that identifies the base element |
context | token | A use context assigned to the activity definition |
context-quantity | quantity | A quantity- or range-valued use context assigned to the activity definition |
context-type | token | A type of use context assigned to the activity definition |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the activity definition |
context-type-value | composite | A use context type and value assigned to the activity definition |
date | date | The activity definition publication date |
derivation | token | specialization |
description | string | The description of the activity definition |
experimental | token | For testing purposes, not real usage |
ext-context | composite | An extension context assigned to the structure definition |
ext-context-expression | token | An expression of extension context assigned to the structure definition |
ext-context-type | token | A type of extension context assigned to the structure definition |
identifier | token | External identifier for the activity definition |
jurisdiction | token | Intended jurisdiction for the activity definition |
keyword | token | A code for the StructureDefinition |
kind | token | primitive-type |
name | string | Computationally friendly name of the activity definition |
path | token | A path that is constrained in the StructureDefinition |
publisher | string | Name of the publisher of the activity definition |
status | token | The current status of the activity definition |
title | string | The human-friendly name of the activity definition |
type | uri | Type defined or constrained by this structure |
url | uri | The uri that identifies the activity definition |
valueset | reference | A vocabulary binding reference |
version | token | The business version of the activity definition |
Reference
- Official FHIR R5 spec:
StructureDefinition - Maturity: Normative (FMM 5).