Release 4 Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2

Extension-practitioner-animalspecies.json

Example Consent/consent-example-pkb (XML)

Patient Administration Community Based Collaborative Care Work Group Maturity Level : N/A Standards Status : Informative Compartments : Patient

Raw JSON XML ( canonical form + also see JSON XML Format Specification )

Jump past Narrative

animalSpecies Example of Patients Know Best Usage (id = "consent-example-pkb")

{ "resourceType" : "StructureDefinition", "id" : "practitioner-animalSpecies", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode" : "pa" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger" : 1 }], "url" : "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies", "version" : "4.0.1", "name" : "animalSpecies", "title" : "animalSpecies", "status" : "draft", "date" : "2019-11-01T09:29:23+11:00", "publisher" : "HL7", "description" : "This extension should be used to specifiy that a practioner or RelatedPerson resource is a service animal.", "fhirVersion" : "4.0.1", "mapping" : [{ "identity" : "rim", "uri" : "http://hl7.org/v3", "name" : "RIM Mapping" }], "kind" : "complex-type", "abstract" : false, "context" : [{ "type" : "element", "expression" : "Practitioner" }, { "type" : "element", "expression" : "RelatedPerson" }], "type" : "Extension", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension", "derivation" : "constraint", "snapshot" : { "element" : [{ "id" : "Extension", "path" : "Extension", "short" : "The Species of the Service Animal", "definition" : "This extension should be used to specifiy that a practioner or RelatedPerson resource is a service animal.", "min" : 0, "max" : "1", "base" : { "path" : "Extension", "min" : 0, "max" : "*" }, "condition" : ["ele-1"], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false }, { "id" : "Extension.id", "path" : "Extension.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Extension.extension", "path" : "Extension.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Extension", "definition" : "An Extension", "min" : 0, "max" : "0", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Extension.url", "path" : "Extension.url", "representation" : ["xmlAttr"], "short" : "identifies the meaning of the extension", "definition" : "Source of the definition for the extension code - a logical name or a URL.", "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min" : 1, "max" : "1", "base" : { "path" : "Extension.url", "min" : 1, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "uri" }], "code" : "http://hl7.org/fhirpath/System.String" }], "fixedUri" : "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies", "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Extension.value[x]", "path" : "Extension.value[x]", "short" : "Value of extension", "definition" : "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list).", "min" : 1, "max" : "1", "base" : { "path" : "Extension.value[x]", "min" : 0, "max" : "1" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "AnimalSpecies" }], "strength" : "example", "description" : "The species of animal.", "valueSet" : "http://hl7.org/fhir/ValueSet/animal-species" }, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }] }, "differential" : { "element" : [{ "id" : "Extension", "path" : "Extension", "short" : "The Species of the Service Animal", "definition" : "This extension should be used to specifiy that a practioner or RelatedPerson resource is a service animal.", "min" : 0, "max" : "1" }, { "id" : "Extension.extension", "path" : "Extension.extension", "max" : "0" }, { "id" : "Extension.url", "path" : "Extension.url", "fixedUri" : "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies" }, { "id" : "Extension.value[x]", "path" : "Extension.value[x]", "min" : 1, "type" : [{ "code" : "CodeableConcept" }], "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "AnimalSpecies" }], "strength" : "example", "description" : "The species of animal.", "valueSet" : "http://hl7.org/fhir/ValueSet/animal-species" } }] } } 
<?xml version="1.0" encoding="UTF-8"?>

<Consent xmlns="http://hl7.org/fhir">
  <id value="consent-example-pkb"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This example demonstrates how to encode this screen shot in a consent resource:</p> 
      <p> 
        <img alt="Screenshot from Patient Knows Best" src="pkb.png"/> 
      </p> 
      <p> Thanks to <a href="https://www.patientsknowbest.com/">Patients Know Best</a>  for contributing this example</p> 
      <p> Example uses SecurityLabels to define data types</p> 
    </div> 
  </text> 
  <status value="active"/> 


  <category> 
    <coding> 
      <system value="http://loinc.org"/> 
      <code value="59284-0"/> 
    </coding> 
  </category> 
  <subject> 
    <reference value="Patient/example"/> 
    <display value="Peter James Chalmers"/> 
  </subject> 
  <date value="2018-12-28"/> 
  <controller> 
    <reference value="Organization/f001"/> 
  </controller> 
    <!--   nothing is approved unless the patient says it is   -->
  <regulatoryBasis> 
    <coding> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> 
      <code value="INFA"/> 
    </coding> 
  </regulatoryBasis> 
  <provision> 
    <type value="deny"/> 
    <provision> 
        <!--   we permit   -->
      <type value="permit"/> 
      <actor> 
          <!--   as a receiver of data   -->
        <role> 
          <coding> 
            <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
            <code value="PRCP"/> 
          </coding> 
        </role> 
          <!--   the non-migrated team   -->
        <reference> 
          <reference value="Organization/f001"/> 
        </reference> 
      </actor> 
        <!--   to read   -->
      <action> 
        <coding> 
          <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
          <code value="access"/> 
        </coding> 
      </action> 
        <!--   any data with confidentiality N   -->
      <securityLabel> 
        <system value="http://terminology.hl7.org/CodeSystem/v3-Confidentiality"/> 
        <code value="N"/> 
      </securityLabel> 
      <provision> 
          <!--   we permit   -->
        <type value="permit"/> 
        <actor> 
            <!--   as a receiver of data   -->
          <role> 
            <coding> 
              <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
              <code value="PRCP"/> 
            </coding> 
          </role> 
            <!--   the non-migrated team   -->
          <reference> 
            <reference value="Organization/f001"/> 
          </reference> 
        </actor> 
          <!--   to read   -->
        <action> 
          <coding> 
            <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
            <code value="access"/> 
          </coding> 
        </action> 
          <!--   any data with tag PSY (see security labels)   -->
        <securityLabel> 
          <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> 
          <code value="PSY"/> 
        </securityLabel> 
      </provision> 
      <provision> 
          <!--   we permit   -->
        <type value="permit"/> 
        <actor> 
            <!--   as a receiver of data   -->
          <role> 
            <coding> 
              <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
              <code value="PRCP"/> 
            </coding> 
          </role> 
            <!--   the non-migrated team   -->
          <reference> 
            <reference value="Organization/f001"/> 
          </reference> 
        </actor> 
          <!--   to read   -->
        <action> 
          <coding> 
            <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
            <code value="access"/> 
          </coding> 
        </action> 
          <!--   any data with and tag SPI (see security labels). SPI is nearest?   -->
        <securityLabel> 
          <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> 
          <code value="SPI"/> 
        </securityLabel> 
      </provision> 
        <!--   other teams follow the same pattern   -->
      <provision> 
        <type value="permit"/> 
        <actor> 
          <role> 
            <coding> 
              <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
              <code value="PRCP"/> 
            </coding> 
          </role> 
          <reference> 
            <reference value="Organization/f001"/> 
          </reference> 
        </actor> 
        <action> 
          <coding> 
            <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
            <code value="access"/> 
          </coding> 
        </action> 
        <securityLabel> 
          <system value="http://terminology.hl7.org/CodeSystem/v3-Confidentiality"/> 
          <code value="N"/> 
        </securityLabel> 
      </provision> 
      <provision> 
        <type value="permit"/> 
        <actor> 
          <role> 
            <coding> 
              <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
              <code value="PRCP"/> 
            </coding> 
          </role> 
          <reference> 
            <reference value="Organization/f001"/> 
          </reference> 
        </actor> 
        <action> 
          <coding> 
            <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
            <code value="access"/> 
          </coding> 
        </action> 
        <securityLabel> 
          <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> 
          <code value="PSY"/> 
        </securityLabel> 
      </provision> 
      <provision> 
        <type value="permit"/> 
        <actor> 
          <role> 
            <coding> 
              <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
              <code value="PRCP"/> 
            </coding> 
          </role> 
          <reference> 
            <reference value="Organization/f001"/> 
          </reference> 
        </actor> 
        <action> 
          <coding> 
            <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
            <code value="access"/> 
          </coding> 
        </action> 
        <securityLabel> 
          <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> 
          <code value="SPI"/> 
        </securityLabel> 
      </provision> 
      <provision> 
        <type value="permit"/> 
        <actor> 
          <role> 
            <coding> 
              <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
              <code value="PRCP"/> 
            </coding> 
          </role> 
          <reference> 
            <reference value="Organization/f001"/> 
          </reference> 
        </actor> 
        <action> 
          <coding> 
            <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
            <code value="access"/> 
          </coding> 
        </action> 
        <securityLabel> 
          <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> 
          <code value="SEX"/> 
        </securityLabel> 
      </provision> 
      <provision> 
        <type value="permit"/> 
        <actor> 
          <role> 
            <coding> 
              <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
              <code value="PRCP"/> 
            </coding> 
          </role> 
          <reference> 
            <reference value="Organization/f001"/> 
          </reference> 
        </actor> 
        <action> 
          <coding> 
            <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
            <code value="access"/> 
          </coding> 
        </action> 
        <securityLabel> 
          <system value="http://terminology.hl7.org/CodeSystem/v3-Confidentiality"/> 
          <code value="N"/> 
        </securityLabel> 
      </provision> 
      <provision> 
        <type value="permit"/> 
        <actor> 
          <role> 
            <coding> 
              <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
              <code value="PRCP"/> 
            </coding> 
          </role> 
          <reference> 
            <reference value="Organization/f001"/> 
          </reference> 
        </actor> 
        <action> 
          <coding> 
            <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
            <code value="access"/> 
          </coding> 
        </action> 
        <securityLabel> 
          <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> 
          <code value="PSY"/> 
        </securityLabel> 
      </provision> 
      <provision> 
        <actor> 
          <role> 
            <coding> 
              <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
              <code value="PRCP"/> 
            </coding> 
          </role> 
          <reference> 
            <reference value="Organization/f001"/> 
          </reference> 
        </actor> 
        <action> 
          <coding> 
            <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
            <code value="access"/> 
          </coding> 
        </action> 
        <securityLabel> 
          <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> 
          <code value="SPI"/> 
        </securityLabel> 
      </provision> 
      <provision> 
        <actor> 
          <role> 
            <coding> 
              <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
              <code value="PRCP"/> 
            </coding> 
          </role> 
          <reference> 
            <reference value="Organization/f001"/> 
          </reference> 
        </actor> 
        <action> 
          <coding> 
            <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
            <code value="access"/> 
          </coding> 
        </action> 
        <securityLabel> 
          <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> 
          <code value="SEX"/> 
        </securityLabel> 
      </provision> 
      <provision> 
        <type value="permit"/> 
        <actor> 
          <role> 
            <coding> 
              <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
              <code value="PRCP"/> 
            </coding> 
          </role> 
          <reference> 
            <reference value="Organization/f001"/> 
          </reference> 
        </actor> 
        <action> 
          <coding> 
            <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
            <code value="access"/> 
          </coding> 
        </action> 
        <securityLabel> 
          <system value="http://terminology.hl7.org/CodeSystem/v3-Confidentiality"/> 
          <code value="N"/> 
        </securityLabel> 
      </provision> 
    </provision> 
  </provision> 

</

Consent

>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.