StructureDefinition - FHIR Resource (dstu2)
This StructureDefinition Resource uses the FHIR API standard for access and structure.
Validate an StructureDefinition FHIR Resource (dstu2)
StructureDefinition Attributes
AttributeField is listTypeDescription
Description: Assist with indexing and finding
FHIR Version: dstu2
Attribute Type : Coding
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": Learn more about the (StructureDefinition) code FHIR attribute
Description: Whether the structure is abstract
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"abstract": Learn more about the (StructureDefinition) abstract FHIR attribute
Description: Scope and Usage this structure definition is for
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requirements": Learn more about the (StructureDefinition) requirements FHIR attribute
Description: Use and/or publishing restrictions
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"copyright": Learn more about the (StructureDefinition) copyright FHIR attribute
Description: Logical id for this version of the StructureDefinition
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": Learn more about the (StructureDefinition) version FHIR attribute
Description: draft | active | retired
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (StructureDefinition) status FHIR attribute
Description: Natural language description of the StructureDefinition
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (StructureDefinition) description FHIR attribute
Description: FHIR Version this StructureDefinition targets
FHIR Version: dstu2
Attribute Type : id
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"fhirVersion": Learn more about the (StructureDefinition) fhirVersion FHIR attribute
Description: C? Any datatype or resource, including abstract ones
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"constrainedType": Learn more about the (StructureDefinition) constrainedType FHIR attribute
Description: External specification that the content is mapped to
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"mapping": Learn more about the (StructureDefinition) mapping FHIR attribute
Description: C? Structure that this set of constraints applies to
FHIR Version: dstu2
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"base": Learn more about the (StructureDefinition) base FHIR attribute
Description: Content intends to support these contexts
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": Learn more about the (StructureDefinition) useContext FHIR attribute
Description: Date for this version of the StructureDefinition
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": Learn more about the (StructureDefinition) date FHIR attribute
Description: Name of the publisher (Organization or individual)
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": Learn more about the (StructureDefinition) publisher FHIR attribute
Description: datatype | resource | logical
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"kind": Learn more about the (StructureDefinition) kind FHIR attribute
Description: Informal name for this StructureDefinition
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": Learn more about the (StructureDefinition) name FHIR attribute
Description: Absolute URL used to reference this StructureDefinition
FHIR Version: dstu2
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (StructureDefinition) url FHIR attribute
Description: C? Differential view of the structure
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"differential": Learn more about the (StructureDefinition) differential FHIR attribute
Description: C? resource | datatype | mapping | extension
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contextType": Learn more about the (StructureDefinition) contextType FHIR attribute
Description: Contact details of the publisher
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (StructureDefinition) contact FHIR attribute
Description: C? Snapshot view of the structure
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"snapshot": Learn more about the (StructureDefinition) snapshot FHIR attribute
Description: C? Where the extension can be used in instances
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"context": Learn more about the (StructureDefinition) context FHIR attribute
Description: Other identifiers for the StructureDefinition
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (StructureDefinition) identifier FHIR attribute
Description: Use this name when displaying the value
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"display": Learn more about the (StructureDefinition) display FHIR attribute
Description: If for testing purposes, not real usage
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": Learn more about the (StructureDefinition) experimental FHIR attribute
StructureDefinition Structure
{
"resourceType" : "StructureDefinition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // R! Absolute URL used to reference this StructureDefinition
"identifier" : [{ Identifier }], // Other identifiers for the StructureDefinition
"version" : "<string>", // Logical id for this version of the StructureDefinition
"name" : "<string>", // R! Informal name for this StructureDefinition
"display" : "<string>", // Use this name when displaying the value
"status" : "<code>", // R! draft | active | retired
"experimental" : <boolean>, // If for testing purposes, not real usage
"publisher" : "<string>", // Name of the publisher (Organization or individual)
"contact" : [{ // Contact details of the publisher
"name" : "<string>", // Name of a individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or publisher
}],
"date" : "<dateTime>", // Date for this version of the StructureDefinition
"description" : "<string>", // Natural language description of the StructureDefinition
"useContext" : [{ CodeableConcept }], // Content intends to support these contexts
"requirements" : "<string>", // Scope and Usage this structure definition is for
"copyright" : "<string>", // Use and/or publishing restrictions
"code" : [{ Coding }], // Assist with indexing and finding
"fhirVersion" : "<id>", // FHIR Version this StructureDefinition targets
"mapping" : [{ // External specification that the content is mapped to
"identity" : "<id>", // R! Internal id when this mapping is used
"uri" : "<uri>", // C? Identifies what this mapping refers to
"name" : "<string>", // C? Names what this mapping refers to
"comments" : "<string>" // Versions, Issues, Scope limitations etc.
}],
"kind" : "<code>", // R! datatype | resource | logical
"constrainedType" : "<code>", // C? Any datatype or resource, including abstract ones
"abstract" : <boolean>, // R! Whether the structure is abstract
"contextType" : "<code>", // C? resource | datatype | mapping | extension
"context" : ["<string>"], // C? Where the extension can be used in instances
"base" : "<uri>", // C? Structure that this set of constraints applies to
"snapshot" : { // C? Snapshot view of the structure
"element" : [{ ElementDefinition }] // C? R! Definition of elements in the resource (if no StructureDefinition)
},
"differential" : { // C? Differential view of the structure
"element" : [{ ElementDefinition }] // R! Definition of elements in the resource (if no StructureDefinition)
}
}
StructureDefinition Search Parameters
The following search parameters can be used to query StructureDefinition resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/StructureDefinition?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
abstract | text | abstract |
base | uri | base |
base-path | text | snapshot.element.base.path, StructureDefinition.differential.element.base.path |
code | text | code |
context | text | useContext |
context-type | text | contextType |
date | date | date |
description | text | description |
display | text | display |
experimental | text | experimental |
ext-context | text | context |
identifier | text | identifier |
kind | text | kind |
name | text | name |
path | text | snapshot.element.path, StructureDefinition.differential.element.path |
publisher | text | publisher |
status | text | status |
type | text | constrainedType |
url | uri | url |
valueset | reference | snapshot.element.binding.valueSet[x] |
version | text | version |
