AI Transparency on FHIR
1.0.0-current - STU1 Ballot International flag

AI Transparency on FHIR, published by HL7 International / Electronic Health Records. This guide is not an authorized publication; it is the continuous build for version 1.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/aitransparency-ig/ and changes regularly. See the Directory of published versions

: Provenance for AI with Model-Card, input, and output

Page standards status: Informative

Raw xml | Download


<Provenance xmlns="http://hl7.org/fhir">
  <id value="AI-full-lorem-ipsum"/>
  <meta>
    <profile
             value="http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-Provenance"/>
  </meta>
  <language value="en"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Provenance AI-full-lorem-ipsum</b></p><a name="AI-full-lorem-ipsum"> </a><a name="hcAI-full-lorem-ipsum"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-AI-Provenance.html">AI Provenance</a></p></div><p>Provenance for: </p><ul><li><a href="http://server.example.org/fhir/Observation/14">http://server.example.org/fhir/Observation/14</a></li><li><a href="http://server.example.org/fhir/CarePlan/19">http://server.example.org/fhir/CarePlan/19</a></li></ul><p>Summary</p><table class="grid"><tr><td>Occurrence</td><td>2023-10-01 00:00:00+0000</td></tr><tr><td>Recorded</td><td>2023-10-01 00:00:00+0000</td></tr><tr><td>Policy</td><td><a href="http://example.org/policies/ai-authorized-CDS">http://example.org/policies/ai-authorized-CDS</a></td></tr></table><p><b>Agents</b></p><table class="grid"><tr><td><b>Type</b></td><td><b>Role</b></td><td><b>who</b></td></tr><tr><td><span title="Codes:{http://terminology.hl7.org/CodeSystem/provenance-participant-type verifier}">Verifier</span></td><td/><td><a href="http://server.example.org/fhir/Practitioner/pract">http://server.example.org/fhir/Practitioner/pract</a></td></tr><tr><td><span title="Codes:{http://terminology.hl7.org/CodeSystem/provenance-participant-type author}">Author</span></td><td/><td><a href="Device-Attached-ModelCard.html">Device: extension = Large Language Models,-&gt;DocumentReference: identifier = https://github.com/huggingface/huggingface_hub/tree/main/tests/fixtures/cards#sample_datasetcard_simple.md; status = current; type = AI Model-Card; category = Markdown Format; identifier = http://example.org/ehr/client-ids#goodhealth; manufacturer = Acme Devices, Inc; type = All kinds of Artificial Intelligence; contact = http://example.org</a></td></tr></table></div>
  </text>
  <contained>
    <DocumentReference>
      <id value="Input-Prompt-lorem-ipsum"/>
      <meta>
        <profile
                 value="http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-InputPrompt"/>
      </meta>
      <status value="current"/>
      <type>
        <coding>
          <system
                  value="http://hl7.org/fhir/uv/aitransparency/CodeSystem/AIinputsCS"/>
          <code value="AIInputPrompt"/>
        </coding>
      </type>
      <description
                   value="Generate a lorem ipsum text to serve as placeholder copy for use in design, development, and publishing. 

1. Specify the exact amount of text or the number of paragraphs required (e.g., 1 paragraph, 3 paragraphs, etc.). 
2. Create the lorem ipsum text using a classic style or introduce slight variations while keeping the nonsensical nature to suit the requested length. 

Ensure that the text maintains a good balance between readability and the traditional lorem ipsum style, giving a realistic impression of how the text will impact the overall layout and design.

# Output Format
- Provide a continuous block of lorem ipsum text corresponding to the specified amount needed."/>
      <content>
        <attachment>
          <contentType value="text/markdown"/>
          <data
                value="R2VuZXJhdGUgYSBsb3JlbSBpcHN1bSB0ZXh0IHRvIHNlcnZlIGFzIHBsYWNlaG9sZGVyIGNvcHkgZm9yIHVzZSBpbiBkZXNpZ24sIGRldmVsb3BtZW50LCBhbmQgcHVibGlzaGluZy4gCgoxLiBTcGVjaWZ5IHRoZSBleGFjdCBhbW91bnQgb2YgdGV4dCBvciB0aGUgbnVtYmVyIG9mIHBhcmFncmFwaHMgcmVxdWlyZWQgKGUuZy4sIDEgcGFyYWdyYXBoLCAzIHBhcmFncmFwaHMsIGV0Yy4pLiAKMi4gQ3JlYXRlIHRoZSBsb3JlbSBpcHN1bSB0ZXh0IHVzaW5nIGEgY2xhc3NpYyBzdHlsZSBvciBpbnRyb2R1Y2Ugc2xpZ2h0IHZhcmlhdGlvbnMgd2hpbGUga2VlcGluZyB0aGUgbm9uc2Vuc2ljYWwgbmF0dXJlIHRvIHN1aXQgdGhlIHJlcXVlc3RlZCBsZW5ndGguIAoKRW5zdXJlIHRoYXQgdGhlIHRleHQgbWFpbnRhaW5zIGEgZ29vZCBiYWxhbmNlIGJldHdlZW4gcmVhZGFiaWxpdHkgYW5kIHRoZSB0cmFkaXRpb25hbCBsb3JlbSBpcHN1bSBzdHlsZSwgZ2l2aW5nIGEgcmVhbGlzdGljIGltcHJlc3Npb24gb2YgaG93IHRoZSB0ZXh0IHdpbGwgaW1wYWN0IHRoZSBvdmVyYWxsIGxheW91dCBhbmQgZGVzaWduLgoKIyBPdXRwdXQgRm9ybWF0Ci0gUHJvdmlkZSBhIGNvbnRpbnVvdXMgYmxvY2sgb2YgbG9yZW0gaXBzdW0gdGV4dCBjb3JyZXNwb25kaW5nIHRvIHRoZSBzcGVjaWZpZWQgYW1vdW50IG5lZWRlZC4="/>
        </attachment>
      </content>
    </DocumentReference>
  </contained>
  <target>
    <extension url="http://hl7.org/fhir/StructureDefinition/targetPath">
      <valueString value="Observation.interpretation"/>
    </extension>
    <reference value="http://server.example.org/fhir/Observation/14"/>
  </target>
  <target>
    <reference value="http://server.example.org/fhir/CarePlan/19"/>
  </target>
  <occurredDateTime value="2023-10-01T00:00:00Z"/>
  <recorded value="2023-10-01T00:00:00Z"/>
  <policy value="http://example.org/policies/ai-authorized-CDS"/>
  <reason>
    <coding>
      <system value="http://terminology.hl7.org/CodeSystem/v3-ActReason"/>
      <code value="TREAT"/>
    </coding>
  </reason>
  <reason>
    <coding>
      <system
              value="http://terminology.hl7.org/CodeSystem/v3-ObservationValue"/>
      <code value="AIAST"/>
    </coding>
  </reason>
  <agent>
    <type>
      <coding>
        <system
                value="http://terminology.hl7.org/CodeSystem/provenance-participant-type"/>
        <code value="verifier"/>
        <display value="Verifier"/>
      </coding>
    </type>
    <who>
      <reference value="http://server.example.org/fhir/Practitioner/pract"/>
    </who>
  </agent>
  <agent>
    <type>
      <coding>
        <system
                value="http://terminology.hl7.org/CodeSystem/provenance-participant-type"/>
        <code value="author"/>
        <display value="Author"/>
      </coding>
    </type>
    <role>
      <coding>
        <system
                value="http://hl7.org/fhir/uv/aitransparency/CodeSystem/AIdeviceTypeCS"/>
        <code value="Artificial-Intelligence"/>
      </coding>
    </role>
    <who>🔗 
      <reference value="Device/Attached-ModelCard"/>
    </who>
  </agent>
  <entity>
    <role value="source"/>
    <what>
      <reference
                 value="http://server.example.org/fhir/documentreference/patient-cda-summary"/>
    </what>
  </entity>
  <entity>
    <role value="source"/>
    <what>
      <reference
                 value="http://server.example.org/fhir/Observation/patient-lab-result"/>
    </what>
  </entity>
  <entity>
    <role value="derivation"/>
    <what>
      <reference
                 value="http://server.example.org/fhir/PlanDefinition/plan-definition-example"/>
    </what>
  </entity>
  <entity>
    <role value="derivation"/>
    <what>
      <reference value="#Input-Prompt-lorem-ipsum"/>
    </what>
    <agent>
      <type>
        <coding>
          <system
                  value="http://terminology.hl7.org/CodeSystem/provenance-participant-type"/>
          <code value="author"/>
          <display value="Author"/>
        </coding>
      </type>
      <who>
        <reference value="http://server.example.org/fhir/Practitioner/pract"/>
      </who>
    </agent>
  </entity>
</Provenance>