StructureDefinition - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
abstractfalseboolean Whether the structure is abstract
baseDefinitionfalseuri C? Definition that this type is constrained/specialized from
contacttrueContactDetail Contact details for the publisher
contexttruestring C? Where the extension can be used in instances
contextInvarianttruestring C? FHIRPath invariants - when the extension can be used
contextTypefalsecode C? resource | datatype | extension
copyrightfalsemarkdown Use and/or publishing restrictions
datefalsedateTime Date this was last changed
derivationfalsecode C? specialization | constraint - How relates to base definition
descriptionfalsemarkdown Natural language description of the structure definition
differentialfalseData Type C? Differential view of the structure
experimentalfalseboolean For testing purposes, not real usage
fhirVersionfalseid FHIR Version this StructureDefinition targets
identifiertrueIdentifier Additional identifier for the structure definition
jurisdictiontrueCodeableConcept Intended jurisdiction for structure definition (if applicable)
keywordtrueCoding Assist with indexing and finding
kindfalsecode primitive-type | complex-type | resource | logical
mappingtrueData Type External specification that the content is mapped to
namefalsestring Name for this structure definition (computer friendly)
publisherfalsestring Name of the publisher (organization or individual)
purposefalsemarkdown Why this structure definition is defined
snapshotfalseData Type C? Snapshot view of the structure
statusfalsecode draft | active | retired | unknown
titlefalsestring Name for this structure definition (human friendly)
typefalsecode C? Type defined or constrained by this structure
urlfalseuri Logical URI to reference this structure definition (globally unique)
useContexttrueUsageContext Context the content is intended to support
versionfalsestring Business version of the structure definition

StructureDefinition Example

{
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>url</b>: <a>http://hl7.org/fhir/StructureDefinition/example</a></p><p><b>identifier</b>: 1.2.36.90146595217.4.2</p><p><b>version</b>: 2</p><p><b>name</b>: LipidProfileExample</p><p><b>title</b>: Example Lipid Profile</p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 12/05/2012</p><p><b>publisher</b>: Health Intersections Pty Ltd</p><p><b>contact</b>: </p><p><b>description</b>: Describes how the lab report is used for a standard Lipid Profile - Cholesterol, Triglyceride and Cholesterol fractions. Uses LOINC codes</p><p><b>useContext</b>: </p><p><b>jurisdiction</b>: Austria <span>(Details : {urn:iso:std:iso:3166 code 'AU' = 'Austria)</span></p><p><b>purpose</b>: Provide an example to demonstrate how to use StructureDefinition</p><p><b>copyright</b>: Creative Commons 0, per FHIR specification</p><p><b>keyword</b>: Hyperlipidemia screening test (procedure) (Details: SNOMED CT code 314079002 = 'Hyperlipidaemia screening test', stated as 'Hyperlipidemia screening test (procedure)')</p><p><b>fhirVersion</b>: 1.0.0</p><h3>Mappings</h3><table><tr><td>-</td><td><b>Identity</b></td><td><b>Uri</b></td><td><b>Name</b></td><td><b>Comment</b></td></tr><tr><td>*</td><td>m1</td><td><a>https://www.rcpa.edu.au/getattachment/0961c6d1-ec80-4500-8dc0-de516500e05b/Lipid-and-lipoprotein-testing.aspx</a></td><td>RCPA Lipid Report recommendations</td><td>Actual mappings haven't yet been filled out</td></tr></table><p><b>kind</b>: resource</p><p><b>abstract</b>: false</p><p><b>type</b>: DiagnosticReport</p><p><b>baseDefinition</b>: <a>http://hl7.org/fhir/StructureDefinition/DiagnosticReport</a></p><p><b>derivation</b>: constraint</p><h3>Snapshots</h3><table><tr><td>-</td><td><b>Element</b></td></tr><tr><td>*</td><td>todo-bundle</td></tr></table></div>"
  },
  "abstract": false,
  "jurisdiction": [
    {
      "coding": [
        {
          "code": "AU",
          "system": "urn:iso:std:iso:3166"
        }
      ]
    }
  ],
  "id": "example",
  "copyright": "Creative Commons 0, per FHIR specification",
  "title": "Example Lipid Profile",
  "version": "2",
  "type": "DiagnosticReport",
  "status": "draft",
  "description": "Describes how the lab report is used for a standard Lipid Profile - Cholesterol, Triglyceride and Cholesterol fractions. Uses LOINC codes",
  "fhirVersion": "1.0.0",
  "mapping": [
    {
      "comment": "Actual mappings haven't yet been filled out",
      "uri": "https://www.rcpa.edu.au/getattachment/0961c6d1-ec80-4500-8dc0-de516500e05b/Lipid-and-lipoprotein-testing.aspx",
      "identity": "m1",
      "name": "RCPA Lipid Report recommendations"
    }
  ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
  "useContext": [
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "314079002",
            "system": "http://snomed.info/sct",
            "display": "Hyperlipidemia screening test (procedure)"
          }
        ]
      },
      "code": {
        "code": "focus",
        "system": "http://hl7.org/fhir/usage-context-type",
        "display": "Clinical Focus"
      }
    }
  ],
  "purpose": "Provide an example to demonstrate how to use StructureDefinition",
  "date": "2012-05-12",
  "derivation": "constraint",
  "publisher": "Health Intersections Pty Ltd",
  "kind": "resource",
  "name": "LipidProfileExample",
  "keyword": [
    {
      "code": "314079002",
      "system": "http://snomed.info/sct",
      "display": "Hyperlipidemia screening test (procedure)"
    }
  ],
  "resourceType": "StructureDefinition",
  "url": "http://hl7.org/fhir/StructureDefinition/example",
  "contact": [
    {
      "telecom": [
        {
          "system": "email",
          "value": "grahame@healthintersections.com.au"
        }
      ],
      "name": "Grahame Grieve"
    }
  ],
  "snapshot": {
    "element": [
      {
        "comment": "In this profile, mustSupport means that authoring systems must include the ability to report these elements, and processing systems must cater for them by either displaying them to the user or considering them appropriately in decision support systems.",
        "definition": "The findings and interpretation of a general lipd lab profile.",
        "short": "Lipid Lab Report",
        "min": 1,
        "max": "1",
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport",
          "max": "1",
          "min": 1
        },
        "path": "DiagnosticReport",
        "id": "DiagnosticReport"
      },
      {
        "comment": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
        "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
        "short": "Additional Content defined by implementations",
        "min": 0,
        "max": "*",
        "slicing": {
          "rules": "open",
          "discriminator": [
            {
              "path": "url",
              "type": "value"
            }
          ],
          "ordered": false
        },
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.extension",
          "max": "*",
          "min": 0
        },
        "path": "DiagnosticReport.extension",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "id": "DiagnosticReport.extension"
      },
      {
        "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
        "definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
        "short": "Text summary of the resource, for human interpretation",
        "isModifier": false,
        "min": 0,
        "max": "1",
        "alias": [
          "narrative",
          "html",
          "xhtml",
          "display"
        ],
        "base": {
          "path": "DiagnosticReport.text",
          "max": "1",
          "min": 0
        },
        "path": "DiagnosticReport.text",
        "type": [
          {
            "code": "Narrative"
          }
        ],
        "id": "DiagnosticReport.text"
      },
      {
        "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
        "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
        "short": "Contained, inline Resources",
        "isModifier": false,
        "min": 0,
        "max": "*",
        "alias": [
          "inline resources",
          "anonymous resources",
          "contained resources"
        ],
        "base": {
          "path": "DiagnosticReport.contained",
          "max": "*",
          "min": 0
        },
        "path": "DiagnosticReport.contained",
        "type": [
          {
            "code": "Resource"
          }
        ],
        "id": "DiagnosticReport.contained"
      },
      {
        "comment": "This is labeled as \"Is Modifier\" because applications need to take appropriate action if a report is withdrawn.",
        "definition": "The status of the diagnostic report as a whole.",
        "short": "registered|interim|final|amended|cancelled|withdrawn",
        "min": 1,
        "max": "1",
        "binding": {
          "strength": "required",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/observation-status"
          }
        },
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.status",
          "max": "1",
          "min": 1
        },
        "path": "DiagnosticReport.status",
        "type": [
          {
            "code": "code"
          }
        ],
        "id": "DiagnosticReport.status"
      },
      {
        "comment": "May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report.",
        "definition": "The date and/or time that this version of the report was released from the source diagnostic service.",
        "short": "Date this version was released",
        "min": 1,
        "max": "1",
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.issued",
          "max": "1",
          "min": 1
        },
        "path": "DiagnosticReport.issued",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "id": "DiagnosticReport.issued"
      },
      {
        "definition": "The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.",
        "short": "The subject of the report",
        "min": 1,
        "max": "1",
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.subject",
          "max": "1",
          "min": 1
        },
        "path": "DiagnosticReport.subject",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient",
            "versioning": "either",
            "aggregation": [
              "bundled"
            ]
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group",
            "aggregation": [
              "bundled"
            ]
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device",
            "aggregation": [
              "bundled"
            ]
          }
        ],
        "id": "DiagnosticReport.subject"
      },
      {
        "comment": "This is not necessarily the source of the atomic data items - it's the entity that takes responsibility for the clinical report.",
        "definition": "The diagnostic service that is responsible for issuing the report.",
        "short": "Responsible Diagnostic Service",
        "min": 1,
        "max": "1",
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.performer",
          "max": "1",
          "min": 1
        },
        "path": "DiagnosticReport.performer",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
          }
        ],
        "id": "DiagnosticReport.performer"
      },
      {
        "definition": "The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider.",
        "short": "Id for external references to this report",
        "min": 0,
        "max": "1",
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.identifier",
          "max": "*",
          "min": 0
        },
        "path": "DiagnosticReport.identifier",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "id": "DiagnosticReport.identifier"
      },
      {
        "comment": "Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single Pathology test result resource. Note that there are also cases where one request leads to multiple reports.",
        "definition": "Details concerning a single pathology test requested.",
        "short": "What was requested",
        "min": 0,
        "max": "*",
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.request",
          "max": "*",
          "min": 0
        },
        "path": "DiagnosticReport.request",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest",
            "versioning": "specific",
            "aggregation": [
              "referenced"
            ]
          }
        ],
        "id": "DiagnosticReport.request"
      },
      {
        "definition": "The section of the diagnostic service that performs the examination e.g. biochemistry, haematology, MRI.",
        "short": "Biochemistry, Haematology etc.",
        "min": 0,
        "max": "1",
        "binding": {
          "strength": "preferred",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections"
          }
        },
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.category",
          "max": "1",
          "min": 0
        },
        "path": "DiagnosticReport.category",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "id": "DiagnosticReport.category"
      },
      {
        "comment": "If the diagnostic procedure was performed on the patient, this is the time it was performed. If there is specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic.",
        "definition": "The diagnostically relevant time for this report - that is, the point in time at which the observations that are reported in this diagnostic report relate to the patient.",
        "short": "Diagnostically relevant time of diagnostic report",
        "min": 1,
        "max": "1",
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.effective[x]",
          "max": "1",
          "min": 1
        },
        "path": "DiagnosticReport.effectiveDateTime",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "id": "DiagnosticReport.effectiveDateTime"
      },
      {
        "definition": "Lipid Lab Results.",
        "short": "Lipid Lab Results",
        "min": 4,
        "max": "4",
        "slicing": {
          "rules": "open",
          "discriminator": [
            {
              "path": "reference.resolve().code",
              "type": "value"
            }
          ],
          "ordered": false
        },
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.result",
          "max": "*",
          "min": 0
        },
        "path": "DiagnosticReport.result",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation",
            "versioning": "specific",
            "aggregation": [
              "bundled"
            ]
          }
        ],
        "id": "DiagnosticReport.result"
      },
      {
        "definition": "Reference to Cholesterol Result.",
        "short": "Cholesterol Result",
        "min": 1,
        "max": "1",
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.result",
          "max": "*",
          "min": 0
        },
        "path": "DiagnosticReport.result",
        "sliceName": "Cholesterol",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/cholesterol",
            "versioning": "specific",
            "aggregation": [
              "bundled"
            ]
          }
        ],
        "id": "DiagnosticReport.result.Cholesterol"
      },
      {
        "definition": "Group of elements for Triglyceride result.",
        "short": "Triglyceride Result",
        "min": 1,
        "max": "1",
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.result",
          "max": "*",
          "min": 0
        },
        "path": "DiagnosticReport.result",
        "sliceName": "Triglyceride",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/triglyceride",
            "versioning": "specific",
            "aggregation": [
              "bundled"
            ]
          }
        ],
        "id": "DiagnosticReport.result.Triglyceride"
      },
      {
        "definition": "Group of elements for HDL Cholesterol result.",
        "short": "HDL Cholesterol Result",
        "min": 1,
        "max": "1",
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.result",
          "max": "*",
          "min": 0
        },
        "path": "DiagnosticReport.result",
        "sliceName": "HDLCholesterol",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/hdlcholesterol",
            "versioning": "specific",
            "aggregation": [
              "bundled"
            ]
          }
        ],
        "id": "DiagnosticReport.result.HDLCholesterol"
      },
      {
        "definition": "LDL Cholesterol result, if reported.",
        "short": "LDL Cholesterol result, if reported",
        "min": 0,
        "max": "1",
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.result",
          "max": "*",
          "min": 0
        },
        "path": "DiagnosticReport.result",
        "sliceName": "LDLCholesterol",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/ldlcholesterol",
            "versioning": "specific",
            "aggregation": [
              "bundled"
            ]
          }
        ],
        "id": "DiagnosticReport.result.LDLCholesterol"
      },
      {
        "comment": "It's not unusual for the lab to make some kind of interpretative comment on the set of results.",
        "definition": "May include diagnosis or suggestions for follow up testing.",
        "short": "Clinical Interpretation of Lipid Panel",
        "min": 0,
        "max": "1",
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.conclusion",
          "max": "1",
          "min": 0
        },
        "path": "DiagnosticReport.conclusion",
        "type": [
          {
            "code": "string"
          }
        ],
        "id": "DiagnosticReport.conclusion"
      },
      {
        "comment": "Possible formats: text/html, text/plain, text/rtf, application/msword, application/pdf, application/rtf, application/vnd.oasis.opendocument.text, application/vnd.openxmlformats-officedocument.wordprocessingml.document. Application/pdf is recommended as the most reliable and interoperable in this context.",
        "definition": "Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.",
        "short": "Entire Report as issued",
        "min": 0,
        "max": "*",
        "isModifier": false,
        "base": {
          "path": "DiagnosticReport.representation",
          "max": "*",
          "min": 0
        },
        "path": "DiagnosticReport.representation",
        "type": [
          {
            "code": "Attachment"
          }
        ],
        "id": "DiagnosticReport.representation"
      }
    ]
  },
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "1.2.36.90146595217.4.2"
    }
  ],
  "experimental": true
}

StructureDefinition Structure


  
{
  "resourceType" : "StructureDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Logical URI to reference this structure definition (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the structure definition
  "version" : "<string>", // Business version of the structure definition
  "name" : "<string>", // R!  Name for this structure definition (computer friendly)
  "title" : "<string>", // Name for this structure definition (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the structure definition
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for structure definition (if applicable)
  "purpose" : "<markdown>", // Why this structure definition is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "keyword" : [{ 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
    "comment" : "<string>" // Versions, Issues, Scope limitations etc.
  }],
  "kind" : "<code>", // R!  primitive-type | complex-type | resource | logical
  "abstract" : <boolean>, // R!  Whether the structure is abstract
  "contextType" : "<code>", // C? resource | datatype | extension
  "context" : ["<string>"], // C? Where the extension can be used in instances
  "contextInvariant" : ["<string>"], // C? FHIRPath invariants - when the extension can be used
  "type" : "<code>", // C? R!  Type defined or constrained by this structure
  "baseDefinition" : "<uri>", // C? Definition that this type is constrained/specialized from
  "derivation" : "<code>", // C? specialization | constraint - How relates to base definition
  "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/stu3/StructureDefinition?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
abstracttextabstract
baseuribaseDefinition
base-pathtextsnapshot.element.base.path, differential.element.base.path
context-typetextcontextType
datedatedate
derivationtextderivation
descriptiontextdescription
experimentaltextexperimental
ext-contexttextcontext
identifiertextidentifier
jurisdictiontextjurisdiction
keywordtextkeyword
kindtextkind
nametextname
pathtextsnapshot.element.path, differential.element.path
publishertextpublisher
statustextstatus
titletexttitle
typetexttype
urluriurl
valuesetreferencesnapshot.element.binding.valueSet
versiontextversion