FHIR Release 3 (STU) Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v3.0.2: STU 3). 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-valueset-effectivedate.json

Example Contract/pcd-example-notThis (XML)

Vocabulary Financial Management Work Group Maturity Level : N/A Ballot Standards Status : Informative Compartments : Not linked to any defined compartments

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

Jump past Narrative

effectiveDate ConsentDirective Example (id = "pcd-example-notThis")

{ "resourceType": "StructureDefinition", "id": "valueset-effectiveDate", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "vocab" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate", "name": "effectiveDate", "status": "draft", "date": "2019-10-24T11:53:00+11:00", "publisher": "HL7", "description": "This is the first date-time when the value set version becomes active, so this value is present on Inactive value set versions as well. The start Date_time is expected to be as of 0001 UTC of the Effective Date.", "fhirVersion": "3.0.2", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "contextType": "resource", "context": [ "ValueSet" ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "When the value set version becomes Active and is available for use", "definition": "This is the first date-time when the value set version becomes active, so this value is present on Inactive value set versions as well. The start Date_time is expected to be as of 0001 UTC of the Effective Date.", "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() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "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": "Extension" } ], "isModifier": false }, { "id": "Extension.id", "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "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": [ { "code": "string" } ], "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": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of 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.", "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 level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Extension.valueDate", "path": "Extension.valueDate", "short": "Value of extension", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "date" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] }, "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "When the value set version becomes Active and is available for use", "definition": "This is the first date-time when the value set version becomes active, so this value is present on Inactive value set versions as well. The start Date_time is expected to be as of 0001 UTC of the Effective Date.", "min": 0, "max": "1", "isModifier": false }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "type": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate" }, { "id": "Extension.valueDate", "path": "Extension.valueDate", "type": [ { "code": "date" } ] } ] } } 
<?xml version="1.0" encoding="UTF-8"?>

<Contract xmlns="http://hl7.org/fhir">
  <id value="pcd-example-notThis"/> 


  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">The following scenario is based on existing

      jurisdictional policy and are realized in existing systems in Canada. The
       default policy is
      one of implied consent for the provision of care, so these scenarios all
       deal with withdrawal
      or withholding consent for that purpose. In other jurisdictions, where an
       express consent
      model is used (Opt-In), these would examples would contain the phrase &quot;consent
       to&quot; rather than
      &quot;withhold&quot; or &quot;withdraw&quot; consent for. <p>  specific to use-case 2. Withhold or withdraw consent
        for disclosure of a specific record (e.g. Lab Order/Result) </p> <p>  Patient &quot;P. van de
        Heuvel&quot; Primary Care Provider, Dr. Philip Primary, has ordered a set
         of lab test which Adam
        wishes to keep as private as possible. At the sample collection facility,
         he indicates that
        he would like withhold consent to disclose the order and all results associated
         with that
        specific order from all other providers </p> 
    </div> 
  </text> 


  <issued value="2015-11-18"/> 
    <!--   not bound by a timeframe - Contract.applies   -->


  <subject> 
    <reference value="Patient/f001"/> 
    <display value="P. van de Heuvel"/> 
  </subject> 


  <authority> 
    <reference value="Organization/3"/> 
    <display value="Michigan Health"/> 
  </authority> 


    <!--   and/or would this [also] go into Contract.domain as a Jurisdiction?? (see the

   example on UK Pharamacy Juristiction)   -->
  <domain> 
    <reference value="Location/ukp"/> 
    <display value="UK Pharmacies"/> 
  </domain> 


  <type> 
    <coding> 
      <system value="http://loinc.org"/> 
      <code value="57016-8"/> 
    </coding> 
  </type> 


    <!--   made up code-system to represent the set of privacy consent sub-types known and

   published by Canada Infoway   -->
  <subType> 
    <coding> 
      <system value="http://www.infoway-inforoute.ca.org/Consent-subtype-codes"/> 
      <code value="Opt-In"/> 
      <display value="Default Authorization with exceptions."/> 
    </coding> 
  </subType> 


    <!--   I can easily say to exclude a type of FHIR Resource, but lab-orders is not a

   direct Resource type. Might we put in FHIR based query parameters?   -->
  <term> 
    <identifier> 
      <system value="http://example.org/fhir/term-items"/> 
      <value value="3347689"/> 
    </identifier> 
    <issued value="2015-11-01"/> 
    <applies> 
      <start value="2015-11-18"/> 
    </applies> 
    <type> 
      <coding> 
          <!--   made up code system   -->
        <system value="http://example.org/fhir/consent-term-type-codes"/> 
        <code value="withhold-identified-object-and-related"/> 
        <display value="Withhold the identified object and any other resources that are related to this

         object."/> 
      </coding> 
    </type> 
    <offer> 
      <topic> 
        <reference value="ServiceRequest/lipid"/> 
      </topic> 
        <!--   by not specifying term.actor I assume this means everyone?   -->
      <text value="Withhold this order and any results or related objects from any provider."/> 
    </offer> 
  </term> 


    <!--   the terms of the consent in friendly consumer speak   -->
  <friendly> 
    <contentAttachment> 
      <title value="The terms of the consent in friendly consumer speak."/> 
        <!--   likely use url pointer to common text   -->
    </contentAttachment> 
  </friendly> 


    <!--   the legal terms of the consent in lawyer speak   -->
  <legal> 
    <contentAttachment> 
      <title value="The terms of the consent in lawyer speak."/> 
        <!--   likely use url pointer to common text   -->
        <!--   I think some think that this should be the pointer to the law by which this consent

       is derived under. Such as http://lois-laws.justice.gc.ca/eng/acts/P-21/index.html
         -->
    </contentAttachment> 
  </legal> 

</

Contract

>

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.