GraphDefinition - FHIR Resource (stu3)


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

Validate an GraphDefinition FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
contacttrueContactDetail Contact details for the publisher
datefalsedateTime Date this was last changed
descriptionfalsemarkdown Natural language description of the graph definition
experimentalfalseboolean For testing purposes, not real usage
jurisdictiontrueCodeableConcept Intended jurisdiction for graph definition (if applicable)
linktrueData Type Links this graph makes rules about
namefalsestring Name for this graph definition (computer friendly)
profilefalseuri Profile on base resource
publisherfalsestring Name of the publisher (organization or individual)
purposefalsemarkdown Why this graph definition is defined
startfalsecode Type of resource at which the graph starts
statusfalsecode draft | active | retired | unknown
urlfalseuri Logical URI to reference this graph definition (globally unique)
useContexttrueUsageContext Context the content is intended to support
versionfalsestring Business version of the graph definition

GraphDefinition Example

{
  "status": "draft",
  "publisher": "FHIR Project",
  "name": "Document Generation Template",
  "start": "Composition",
  "resourceType": "GraphDefinition",
  "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://h7.org/fhir/GraphDefinition/example</a></p><p><b>name</b>: Document Generation Template</p><p><b>status</b>: draft</p><p><b>date</b>: 04/08/2015</p><p><b>publisher</b>: FHIR Project</p><p><b>contact</b>: </p><p><b>description</b>: Specify to include list references when generating a document using the $document operation</p><p><b>start</b>: Composition</p><blockquote><p><b>link</b></p><p><b>path</b>: Composition.section.entry</p><p><b>description</b>: Link to List</p><blockquote><p><b>target</b></p><p><b>type</b>: List</p><h3>Compartments</h3><table><tr><td>-</td><td><b>Code</b></td><td><b>Rule</b></td></tr><tr><td>*</td><td>Patient</td><td>identical</td></tr></table><h3>Links</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote></blockquote></div>"
  },
  "url": "http://h7.org/fhir/GraphDefinition/example",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "link": [
    {
      "path": "Composition.section.entry",
      "description": "Link to List",
      "target": [
        {
          "link": [
            {
              "path": "List.entry.item",
              "description": "Include any list entries",
              "target": [
                {
                  "compartment": [
                    {
                      "code": "Patient",
                      "rule": "identical"
                    }
                  ],
                  "type": "Resource"
                }
              ]
            }
          ],
          "compartment": [
            {
              "code": "Patient",
              "rule": "identical"
            }
          ],
          "type": "List"
        }
      ]
    }
  ],
  "date": "2015-08-04",
  "id": "example",
  "description": "Specify to include list references when generating a document using the $document operation"
}

GraphDefinition Structure


  
{
  "resourceType" : "GraphDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this graph definition (globally unique)
  "version" : "<string>", // Business version of the graph definition
  "name" : "<string>", // R!  Name for this graph definition (computer 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 graph definition
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for graph definition (if applicable)
  "purpose" : "<markdown>", // Why this graph definition is defined
  "start" : "<code>", // R!  Type of resource at which the graph starts
  "profile" : "<uri>", // Profile on base resource
  "link" : [{ // Links this graph makes rules about
    "path" : "<string>", // R!  Path in the resource that contains the link
    "sliceName" : "<string>", // Which slice (if profiled)
    "min" : <integer>, // Minimum occurrences for this link
    "max" : "<string>", // Maximum occurrences for this link
    "description" : "<string>", // Why this link is specified
    "target" : [{ // R!  Potential target for the link
      "type" : "<code>", // R!  Type of resource this link refers to
      "profile" : "<uri>", // Profile for the target resource
      "compartment" : [{ // Compartment Consistency Rules
        "code" : "<code>", // R!  Identifies the compartment
        "rule" : "<code>", // R!  identical | matching | different | custom
        "expression" : "<string>", // Custom rule, as a FHIRPath expression
        "description" : "<string>" // Documentation for FHIRPath expression
      }],
      "link" : [{ Content as for GraphDefinition.link }] // Additional links from target resource
    }]
  }]
}


 

GraphDefinition Search Parameters

The following search parameters can be used to query GraphDefinition resources. Just submit the like so:

https://api.1up.health/fhir/stu3/GraphDefinition?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
datedatedate
descriptiontextdescription
jurisdictiontextjurisdiction
nametextname
publishertextpublisher
starttextstart
statustextstatus
urluriurl
versiontextversion