StructureDefinition - FHIR Resource (dstu2)


This StructureDefinition Resource uses the FHIR API standard for access and structure.

Validate an StructureDefinition FHIR Resource (dstu2)



Resource Attributes

AttributeField is listTypeDescription
abstractfalseboolean# Whether the structure is abstract
basefalseuri# C? Structure that this set of constraints applies to
codetrueCoding# Assist with indexing and finding
constrainedTypefalsecode# C? Any datatype or resource, including abstract ones
contacttrueData Type# Contact details of the publisher
contexttruestring# C? Where the extension can be used in instances
contextTypefalsecode# C? resource | datatype | mapping | extension
copyrightfalsestring# Use and/or publishing restrictions
datefalsedateTime# Date for this version of the StructureDefinition
descriptionfalsestring# Natural language description of the StructureDefinition
differentialfalseData Type# C? Differential view of the structure
displayfalsestring# Use this name when displaying the value
experimentalfalseboolean# If for testing purposes, not real usage
fhirVersionfalseid# FHIR Version this StructureDefinition targets
identifiertrueIdentifier# Other identifiers for the StructureDefinition
kindfalsecode# datatype | resource | logical
mappingtrueData Type# External specification that the content is mapped to
namefalsestring# Informal name for this StructureDefinition
publisherfalsestring# Name of the publisher (Organization or individual)
requirementsfalsestring# Scope and Usage this structure definition is for
snapshotfalseData Type# C? Snapshot view of the structure
statusfalsecode# draft | active | retired
urlfalseuri# Absolute URL used to reference this StructureDefinition
useContexttrueCodeableConcept# Content intends to support these contexts
versionfalsestring# Logical id for this version of the StructureDefinition

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 the like so:

https://api.1up.health/fhir/dstu2/StructureDefinition?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
abstracttextabstract
baseuribase
base-pathtextsnapshot.element.base.path, StructureDefinition.differential.element.base.path
codetextcode
contexttextuseContext
context-typetextcontextType
datedatedate
descriptiontextdescription
displaytextdisplay
experimentaltextexperimental
ext-contexttextcontext
identifiertextidentifier
kindtextkind
nametextname
pathtextsnapshot.element.path, StructureDefinition.differential.element.path
publishertextpublisher
statustextstatus
typetextconstrainedType
urluriurl
valuesetreferencesnapshot.element.binding.valueSet[x]
versiontextversion