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.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 24 of 26 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
urlRequiredΣ | 1..1 | uri | Canonical identifier for this structure definition, represented as a URI (globally unique) |
identifierΣ | 0..* | Identifier | Additional identifier for the structure definition |
versionΣ | 0..1 | string | Business version of the structure definition |
nameRequiredΣ | 1..1 | string | Name for this structure definition (computer friendly) |
titleΣ | 0..1 | string | Name for this structure definition (human friendly) |
statusRequired?!Σ | 1..1 | code | draft | active | retired | unknownBinding (required): publication-status |
experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
dateΣ | 0..1 | dateTime | Date last changed |
publisherΣ | 0..1 | string | Name of the publisher (organization or individual) |
contactΣ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the structure definition |
useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for structure definition (if applicable)Binding (extensible): jurisdiction |
purpose | 0..1 | markdown | Why this structure definition is defined |
copyright | 0..1 | markdown | Use and/or publishing restrictions |
keywordΣ | 0..* | Coding | Assist with indexing and findingBinding (extensible): definition-use |
fhirVersionΣ | 0..1 | code | FHIR Version this StructureDefinition targetsBinding (required): FHIR-version |
mapping | 0..* | BackboneElement | External specification that the content is mapped to |
identityRequired | 1..1 | id | Internal id when this mapping is used |
uri | 0..1 | uri | Identifies what this mapping refers to |
name | 0..1 | string | Names what this mapping refers to |
comment | 0..1 | string | Versions, Issues, Scope limitations etc. |
kindRequiredΣ | 1..1 | code | primitive-type | complex-type | resource | logicalBinding (required): structure-definition-kind |
abstractRequiredΣ | 1..1 | boolean | Whether the structure is abstract |
contextΣ | 0..* | BackboneElement | If an extension, where it can be used in instances |
typeRequiredΣ | 1..1 | code | fhirpath | element | extensionBinding (required): extension-context-type |
expressionRequiredΣ | 1..1 | string | Where the extension can be used in instances |
contextInvariantΣ | 0..* | string | FHIRPath invariants - when the extension can be used |
typeRequiredΣ | 1..1 | uri | Type defined or constrained by this structureBinding (extensible): defined-types |
baseDefinitionΣ | 0..1 | canonical(StructureDefinition) | Definition that this type is constrained/specialized from |
derivationΣ | 0..1 | code | specialization | constraint - How relates to base definitionBinding (required): type-derivation-rule |
snapshot | 0..1 | BackboneElement | Snapshot view of the structure |
elementRequired | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) |
differential | 0..1 | BackboneElement | Differential view of the structure |
elementRequired | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/StructureDefinition?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
abstract | token | Whether the structure is abstract StructureDefinition.abstract | ||
base | reference | Definition that this type is constrained/specialized from StructureDefinition.baseDefinition | ||
base-path | token | Path that identifies the base element StructureDefinition.snapshot.element.base.path | StructureDefinition.differential.element.base.path | ||
context | token | A use context assigned to the structure definition (StructureDefinition.useContext.value.ofType(CodeableConcept)) | ||
context-quantity | quantity | A quantity- or range-valued use context assigned to the structure definition (StructureDefinition.useContext.value.ofType(Quantity)) | (StructureDefinition.useContext.value.ofType(Range)) | ||
context-type | token | A type of use context assigned to the structure definition StructureDefinition.useContext.code | ||
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the structure definition StructureDefinition.useContext | ||
context-type-value | composite | A use context type and value assigned to the structure definition StructureDefinition.useContext | ||
date | date | The structure definition publication date StructureDefinition.date | ||
derivation | token | specialization | constraint - How relates to base definition StructureDefinition.derivation | ||
description | string | The description of the structure definition StructureDefinition.description | ||
experimental | token | For testing purposes, not real usage StructureDefinition.experimental | ||
ext-context | token | The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text StructureDefinition.context.type | ||
identifier | token | External identifier for the structure definition StructureDefinition.identifier | ||
jurisdiction | token | Intended jurisdiction for the structure definition StructureDefinition.jurisdiction | ||
keyword | token | A code for the StructureDefinition StructureDefinition.keyword | ||
kind | token | primitive-type | complex-type | resource | logical StructureDefinition.kind | ||
name | string | Computationally friendly name of the structure definition StructureDefinition.name | ||
path | token | A path that is constrained in the StructureDefinition StructureDefinition.snapshot.element.path | StructureDefinition.differential.element.path | ||
publisher | string | Name of the publisher of the structure definition StructureDefinition.publisher | ||
status | token | The current status of the structure definition StructureDefinition.status | ||
title | string | The human-friendly name of the structure definition StructureDefinition.title | ||
type | uri | Type defined or constrained by this structure StructureDefinition.type | ||
url | uri | The uri that identifies the structure definition StructureDefinition.url | ||
valueset | reference | A vocabulary binding reference StructureDefinition.snapshot.element.binding.valueSet | ||
version | token | The business version of the structure definition StructureDefinition.version |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken