This page is part of the FHIR Specification (v0.11: DSTU 1 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Resource Roadmap - Examples 6.3.6

Example Index:

How 'other' can be used for future resources - in this case referralXMLJSON
How 'Other' can be used for essoteric resources - in this case, a UML class modelXMLJSON

Referral 6.3.6.1

How 'other' can be used for future resources - in this case referral

How 'other' can be used for future resources - in this case referral (id = "referral")

Raw XML

<Other xmlns="http://hl7.org/fhir">
  <extension>
    <url value="http://example.org/do-not-use/fhir-extensions/referral#referredForService"/>
    <isModifier value="true"/>
    <valueCodeableConcept>
      <coding>
        <system value="http://snomed.info/sct"/>
        <code value="11429006"/>
        <display value="Consultation"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <extension>
    <url value="http://example.org/do-not-use/fhir-extensions/referral#requestingPractitioner"/>
    <valueResource>
      <type value="Practitioner"/>
      <reference value="practitioner/@f201"/>
      <display value="Dokter Bronsig"/>
    </valueResource>
  </extension>
  <extension>
    <url value="http://example.org/do-not-use/fhir-extensions/referral#targetDate"/>
    <isModifier value="true"/>
    <valuePeriod>
      <start value="2013-04-01"/>
      <end value="2013-04-15"/>
    </valuePeriod>
  </extension>
  <extension>
    <url value="http://example.org/do-not-use/fhir-extensions/referral#status"/>
    <isModifier value="true"/>
    <valueCode value="complete"/>
  </extension>
  <extension>
    <url value="http://example.org/do-not-use/fhir-extensions/referral#notes"/>
    <valueString value="The patient had fever peaks over the last couple of days. He is worried about these peaks."/>
  </extension>
  <extension>
    <url value="http://example.org/do-not-use/fhir-extensions/referral#fulfillingEncounter"/>
    <valueResource>
      <type value="Encounter"/>
      <reference value="encounter/@f201"/>
    </valueResource>
  </extension>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p><b>Patient:</b>Roel</p>
      <p><b>Requestor:</b>Dokter Bronsig</p>
      <p><b>Type:</b>Consultation</p>
      <p><b>Target Date:</b>April 1 - April 31</p>
      <p>COMPLETED</p>
      <b>The patient had fever peaks over the last couple of days. He is worried about these peaks.</b>
    </div>
  </text>
  <code>
    <coding>
      <system value="http://hl7.org/fhir/other-resource-type"/>
      <code value="REFERRAL"/>
    </coding>
  </code>
  <subject>
    <type value="Patient"/>
    <reference value="patient/@f201"/>
    <display value="Roel"/>
  </subject>
</Other>

JSON Equivalent

How 'other' can be used for future resources - in this case referral

{
  "Other":{
    "extension":[
      {
        "url":{
          "value":"http://example.org/do-not-use/fhir-extensions/referral#referredForService"
        },
        "isModifier":{
          "value":true
        },
        "valueCodeableConcept":{
          "coding":[
            {
              "system":{
                "value":"http://snomed.info/sct"
              },
              "code":{
                "value":"11429006"
              },
              "display":{
                "value":"Consultation"
              }
            }
          ]
        }
      },
      {
        "url":{
          "value":"http://example.org/do-not-use/fhir-extensions/referral#requestingPractitioner"
        },
        "valueResource":{
          "type":{
            "value":"Practitioner"
          },
          "reference":{
            "value":"practitioner/@f201"
          },
          "display":{
            "value":"Dokter Bronsig"
          }
        }
      },
      {
        "url":{
          "value":"http://example.org/do-not-use/fhir-extensions/referral#targetDate"
        },
        "isModifier":{
          "value":true
        },
        "valuePeriod":{
          "start":{
            "value":"2013-04-01"
          },
          "end":{
            "value":"2013-04-15"
          }
        }
      },
      {
        "url":{
          "value":"http://example.org/do-not-use/fhir-extensions/referral#status"
        },
        "isModifier":{
          "value":true
        },
        "valueCode":{
          "value":"complete"
        }
      },
      {
        "url":{
          "value":"http://example.org/do-not-use/fhir-extensions/referral#notes"
        },
        "valueString":{
          "value":"The patient had fever peaks over the last couple of days. He is worried about these peaks."
        }
      },
      {
        "url":{
          "value":"http://example.org/do-not-use/fhir-extensions/referral#fulfillingEncounter"
        },
        "valueResource":{
          "type":{
            "value":"Encounter"
          },
          "reference":{
            "value":"encounter/@f201"
          }
        }
      }
    ],
    "text":{
      "status":{
        "value":"generated"
      },
      "div":"<div>\n      <p><b>Patient:<\/b>Roel<\/p>\n      <p><b>Requestor:<\/b>Dokter Bronsig<\/p>\n      <p><b>Type:<\/b>Consultation<\/p>\n      <p><b>Target Date:<\/b>April 1 - April 31<\/p>\n      <p>COMPLETED<\/p>\n      <b>The patient had fever peaks over the last couple of days. He is worried about these peaks.<\/b>\n    <\/div>"
    },
    "code":{
      "coding":[
        {
          "system":{
            "value":"http://hl7.org/fhir/other-resource-type"
          },
          "code":{
            "value":"REFERRAL"
          }
        }
      ]
    },
    "subject":{
      "type":{
        "value":"Patient"
      },
      "reference":{
        "value":"patient/@f201"
      },
      "display":{
        "value":"Roel"
      }
    }
  }
}

ClassModel 6.3.6.2

How 'Other' can be used for essoteric resources - in this case, a UML class model

How 'Other' can be used for essoteric resources - in this case, a UML class model (id = "classModel")

Raw XML

<Other xmlns="http://hl7.org/fhir">
  <extension>
    <extension>
      <url value="http://example.org/do-not-use/fhir-extensions/UML#class.name"/>
      <valueString value="Class1"/>
    </extension>
    <extension>
      <extension>
        <url value="http://example.org/do-not-use/fhir-extensions/UML#class.attribute.name"/>
        <valueString value="attribute1"/>
      </extension>
      <extension>
        <url value="http://example.org/do-not-use/fhir-extensions/UML#class.attribute.minOccurs"/>
        <valueInteger value="1"/>
      </extension>
      <extension>
        <url value="http://example.org/do-not-use/fhir-extensions/UML#class.attribute.maxOccurs"/>
        <valueCode value="*"/>
      </extension>
      <url value="http://example.org/do-not-use/fhir-extensions/UML#class.attribute"/>
    </extension>
    <extension>
      <extension>
        <url value="http://example.org/do-not-use/fhir-extensions/UML#class.attribute.name"/>
        <valueString value="attribute2"/>
      </extension>
      <extension>
        <url value="http://example.org/do-not-use/fhir-extensions/UML#class.attribute.minOccurs"/>
        <valueInteger value="0"/>
      </extension>
      <extension>
        <url value="http://example.org/do-not-use/fhir-extensions/UML#class.attribute.maxOccurs"/>
        <valueInteger value="1"/>
      </extension>
      <url value="http://example.org/do-not-use/fhir-extensions/UML#class.attribute"/>
    </extension>
    <url value="http://example.org/do-not-use/fhir-extensions/UML#class"/>
  </extension>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p><b>Class1</b></p>
      <ul>
        <li>Attribute1: 1..*</li>
        <li>Attribute2: 0..1</li>
      </ul>
    </div>
  </text>
  <code>
    <coding>
      <system value="http://example.org/do-not-use/fhir-codes#resourceTypes"/>
      <code value="UMLCLASSMODEL"/>
    </coding>
  </code>
</Other>

JSON Equivalent

How 'Other' can be used for essoteric resources - in this case, a UML class model

{
  "Other":{
    "extension":[
      {
        "extension":[
          {
            "url":{
              "value":"http://example.org/do-not-use/fhir-extensions/UML#class.name"
            },
            "valueString":{
              "value":"Class1"
            }
          },
          {
            "extension":[
              {
                "url":{
                  "value":"http://example.org/do-not-use/fhir-extensions/UML#class.attribute.name"
                },
                "valueString":{
                  "value":"attribute1"
                }
              },
              {
                "url":{
                  "value":"http://example.org/do-not-use/fhir-extensions/UML#class.attribute.minOccurs"
                },
                "valueInteger":{
                  "value":1
                }
              },
              {
                "url":{
                  "value":"http://example.org/do-not-use/fhir-extensions/UML#class.attribute.maxOccurs"
                },
                "valueCode":{
                  "value":"*"
                }
              }
            ],
            "url":{
              "value":"http://example.org/do-not-use/fhir-extensions/UML#class.attribute"
            }
          },
          {
            "extension":[
              {
                "url":{
                  "value":"http://example.org/do-not-use/fhir-extensions/UML#class.attribute.name"
                },
                "valueString":{
                  "value":"attribute2"
                }
              },
              {
                "url":{
                  "value":"http://example.org/do-not-use/fhir-extensions/UML#class.attribute.minOccurs"
                },
                "valueInteger":{
                  "value":0
                }
              },
              {
                "url":{
                  "value":"http://example.org/do-not-use/fhir-extensions/UML#class.attribute.maxOccurs"
                },
                "valueInteger":{
                  "value":1
                }
              }
            ],
            "url":{
              "value":"http://example.org/do-not-use/fhir-extensions/UML#class.attribute"
            }
          }
        ],
        "url":{
          "value":"http://example.org/do-not-use/fhir-extensions/UML#class"
        }
      }
    ],
    "text":{
      "status":{
        "value":"generated"
      },
      "div":"<div>\n      <p><b>Class1<\/b><\/p>\n      <ul>\n        <li>Attribute1: 1..*<\/li>\n        <li>Attribute2: 0..1<\/li>\n      <\/ul>\n    <\/div>"
    },
    "code":{
      "coding":[
        {
          "system":{
            "value":"http://example.org/do-not-use/fhir-codes#resourceTypes"
          },
          "code":{
            "value":"UMLCLASSMODEL"
          }
        }
      ]
    }
  }
}