Structuredefinition-example.json

Example of structuredefinition

{
  "resourceType": "StructureDefinition",
  "id": "example",
  "url": "http://hl7.org/fhir/StructureDefinition/example",
  "name": "Example Lipid Profile",
  "publisher": "Grahame Grieve",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "grahame@healthintersections.com.au"
        }
      ]
    }
  ],
  "description": "Describes how the lab report is used for a standard Lipid Profile - Cholesterol, Triglyceride and Cholesterol fractions. Uses LOINC codes",
  "status": "draft",
  "date": "2012-05-12",
  "type": "constraint",
  "snapshot": {
    "element": [
      {
        "path": "DiagnosticReport",
        "name": "LipidProfile",
        "short": "Lipid Lab Report",
        "definition": "The findings and interpretation of a general lipd lab profile.",
        "comments": "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.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Resource"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.extension",
        "slicing": {
          "discriminator": [
            "url"
          ],
          "ordered": false,
          "rules": "open"
        },
        "short": "Additional Content defined by implementations",
        "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.",
        "comments": "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.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.text",
        "short": "Text summary of the resource, for human interpretation",
        "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.",
        "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
        "synonym": [
          "narrative",
          "html",
          "xhtml",
          "display"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Narrative"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.contained",
        "short": "Contained, inline Resources",
        "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.",
        "comments": "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.",
        "synonym": [
          "inline resources",
          "anonymous resources",
          "contained resources"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Resource"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.status",
        "short": "registered|interim|final|amended|cancelled|withdrawn",
        "definition": "The status of the diagnostic report as a whole.",
        "comments": "This is labeled as \"Is Modifier\" because applications need to take appropriate action if a report is withdrawn.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": false,
        "binding": {
          "name": "ObservationStatus",
          "isExtensible": false,
          "conformance": "required",
          "referenceReference": {
            "reference": "http://hl7.org/fhir/vs/observation-status"
          }
        }
      },
      {
        "path": "DiagnosticReport.issued",
        "short": "Date this version was released",
        "definition": "The date and/or time that this version of the report was released from the source diagnostic service.",
        "comments": "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.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.subject",
        "short": "The subject of the report",
        "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.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference(Patient|Group|Device)"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.performer",
        "short": "Responsible Diagnostic Service",
        "definition": "The diagnostic service that is responsible for issuing the report.",
        "comments": "This is not necessarily the source of the atomic data items - it's the entity that takes responsibility for the clinical report.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference(Organization)"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.reportId",
        "short": "Id for external references to this report",
        "definition": "The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.requestDetail",
        "short": "What was requested",
        "definition": "Details concerning a single pathology test requested.",
        "comments": "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.",
        "min": 0,
        "max": "*",
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.requestDetail.encounter",
        "short": "Context where request was made",
        "definition": "The encounter that this diagnostic investigation is associated with.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference(Encounter)"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.requestDetail.requestOrderId",
        "short": "Id assigned by requester",
        "definition": "The local ID assigned to the order by the order requester.",
        "comments": "Equivalent to the Placer Order Identifier.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.requestDetail.receiverOrderId",
        "short": "Receiver's Id for the request",
        "definition": "The local ID assigned to the test order by the diagnostic service provider.",
        "comments": "Usually equivalent to the DICOM Accession Number and the Filler Order Identifier.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.requestDetail.requestTest",
        "short": "Test Requested",
        "definition": "Identification of pathology test requested,.",
        "comments": "Useful where the test requested differs from the test actually performed.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isModifier": false,
        "binding": {
          "name": "DiagnosticRequests",
          "isExtensible": true,
          "conformance": "example",
          "referenceReference": {
            "reference": "http://hl7.org/fhir/vs/diagnostic-requests"
          }
        }
      },
      {
        "path": "DiagnosticReport.requestDetail.bodySite",
        "short": "Location of requested test (if applicable)",
        "definition": "Anatomical location where the request test should be performed.",
        "comments": "This is often implicit or explicit in the requested test, and doesn't need to be specified if so.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isModifier": false,
        "binding": {
          "name": "BodySite",
          "isExtensible": true,
          "conformance": "example",
          "referenceReference": {
            "reference": "http://hl7.org/fhir/vs/body-site"
          }
        }
      },
      {
        "path": "DiagnosticReport.requestDetail.requester",
        "short": "Responsible for request",
        "definition": "Details of the clinician or organization requesting the diagnostic service.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference(Organization|Practitioner)"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.requestDetail.clinicalInfo",
        "short": "Clinical information provided",
        "definition": "Details of the clinical information provided to the diagnostic service along with the original request.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.serviceCategory",
        "short": "Biochemistry, Haematology etc.",
        "definition": "The section of the diagnostic service that performs the examination e.g. biochemistry, haematology, MRI.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isModifier": false,
        "binding": {
          "name": "DiagnosticServiceSection",
          "isExtensible": true,
          "conformance": "preferred",
          "referenceReference": {
            "reference": "http://hl7.org/fhir/vs/diagnostic-service-sections"
          }
        }
      },
      {
        "path": "DiagnosticReport.diagnostic[x]",
        "short": "Diagnostically relevant time of diagnostic report",
        "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.",
        "comments": "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.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          },
          {
            "code": "Period"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.results",
        "short": "Lipid Lab Results",
        "definition": "Lipid Lab Results.",
        "min": 1,
        "max": "1",
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.results.name",
        "short": "LOINC Code for Lipid Panel with LDL",
        "definition": "LOINC Code for Lipid Panel with LDL.",
        "comments": "LOINC code includes \"direct\" LDL - does this mean LDL derived by measuring VLDL by ultracentrifugation? This panel includes both measured and calculated LDL.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isModifier": false,
        "binding": {
          "name": "DiagnosticResultGroupNames",
          "isExtensible": true,
          "conformance": "preferred",
          "referenceReference": {
            "reference": "http://hl7.org/fhir/vs/report-names"
          }
        }
      },
      {
        "path": "DiagnosticReport.results.specimen",
        "short": "Specimen details for this group",
        "definition": "Details about the individual specimen to which these 'Result group' test results refer.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference(Specimen)"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.results.group",
        "short": "No subgroups allowed",
        "definition": "No subgroups allowed.",
        "comments": "Nested report groups beyond the first level are not used often, but arise in structured pathology reports, and where there is more than one sensitivity assessment per discovered organism.",
        "min": 0,
        "max": "0",
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.results.result",
        "name": "Cholesterol",
        "slicing": {
          "discriminator": [
            "name"
          ],
          "ordered": false,
          "rules": "open"
        },
        "short": "Cholesterol Result",
        "definition": "Reference to Cholesterol Result.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference(Observation)",
            "profile": "#Cholesterol"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.results.result",
        "name": "Triglyceride",
        "short": "Triglyceride Result",
        "definition": "Group of elements for Triglyceride result.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference(Observation)",
            "profile": "#Triglyceride"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.results.result",
        "name": "HDL Cholesterol",
        "short": "HDL Cholesterol Result",
        "definition": "Group of elements for HDL Cholesterol result.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference(Observation)",
            "profile": "#HDLCholesterol"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.results.result",
        "name": "LDL Cholesterol",
        "short": "LDL Cholesterol result, if reported",
        "definition": "LDL Cholesterol result, if reported.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference(Observation)",
            "profile": "#LDLCholesterol"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.image",
        "short": "Key images associated with this report",
        "definition": "A list of key images associated with this report. The images are generally created during the diagnostic process, and maybe directly of the patient, or of treated specimens (i.e. slides of interest).",
        "comments": "An imaging study is a list of images following a DICOM specification - only list one of these, or multiple images.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference(Media|ImagingStudy)"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.conclusion",
        "short": "Clinical Interpretation of Lipid Panel",
        "definition": "May include diagnosis or suggestions for follow up testing.",
        "comments": "It's not unusual for the lab to make some kind of interpretative comment on the set of results.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isModifier": false
      },
      {
        "path": "DiagnosticReport.codedDiagnosis",
        "short": "No codes for a lipid panel",
        "definition": "No codes for a lipid panel.",
        "comments": "Not used in this context.",
        "min": 0,
        "max": "0",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isModifier": false,
        "binding": {
          "name": "DiagnosisCodes",
          "isExtensible": true,
          "conformance": "example",
          "referenceReference": {
            "reference": "http://hl7.org/fhir/vs/clinical-findings"
          }
        }
      },
      {
        "path": "DiagnosticReport.representation",
        "short": "Entire Report as issued",
        "definition": "Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.",
        "comments": "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.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Attachment"
          }
        ],
        "isModifier": false
      }
    ]
  }
}