Consent Directive Observation Entry (Template)

Aus Hl7wiki
(Teildokument von CDA für die elektronische Fallakte)
Wechseln zu: Navigation, Suche
K (Registration and Upload of a Digital Consent)
 
(5 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
 
{{DocumentPart}}
 
{{DocumentPart}}
 +
 +
=Entry: Consent Directive Observation (Entry)=
 +
 +
{| class="hl7table"
 +
|bgcolor="ddddff"|Template ID|| colspan=2 | 1.2.276.0.76.3.1.81.81.6.4.1
 +
|-
 +
|bgcolor="ddddff"| General Description|| colspan=2 | Hiermit wird auf Entry-Level die Übermittlung von Einwilligungsdetails definiert.
 +
|-
 +
|bgcolor="ddddff"|LOINC Code||bgcolor="ddddff"|Opt.||bgcolor="ddddff"|Description
 +
|-
 +
| ???? || O ||
 +
|}
 +
  
 
A consent directive observation is a specialization of the IHE PCC simple observation content module ([http://wiki.ihe.net/index.php?title=1.3.6.1.4.1.19376.1.5.3.1.4.13 1.3.6.1.4.1.19376.1.5.3.1.4.13]) that uses a specific vocabulary.
 
A consent directive observation is a specialization of the IHE PCC simple observation content module ([http://wiki.ihe.net/index.php?title=1.3.6.1.4.1.19376.1.5.3.1.4.13 1.3.6.1.4.1.19376.1.5.3.1.4.13]) that uses a specific vocabulary.
Zeile 9: Zeile 22:
  
 
<syntaxhighlight lang="xml" heading="template - (1.2.276.0.76.3.1.81.81.6.4.1)" valid="true" highlight="5-11">
 
<syntaxhighlight lang="xml" heading="template - (1.2.276.0.76.3.1.81.81.6.4.1)" valid="true" highlight="5-11">
 +
<entry>
 
   <observation typeCode='OBS' moodCode='EVN'>
 
   <observation typeCode='OBS' moodCode='EVN'>
 
       <templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.13'/>
 
       <templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.13'/>
Zeile 16: Zeile 30:
 
               codeSystem='2.16.840.1.113883.12.498'  
 
               codeSystem='2.16.840.1.113883.12.498'  
 
               codeSystemName='HL7 Consent Status'/>
 
               codeSystemName='HL7 Consent Status'/>
  <!-- scope of the consent (e.g. as defined by eCR Consent Authorization Codes -->
+
      <!-- scope of the consent (e.g. as defined by eCR Consent Authorization Codes -->
 
       <value xsi:type='CD' code=' ' displayName=' '  
 
       <value xsi:type='CD' code=' ' displayName=' '  
 
                           codeSystem='1.2.276.0.76.3.1.81.81.5.1'  
 
                           codeSystem='1.2.276.0.76.3.1.81.81.5.1'  
Zeile 47: Zeile 61:
 
       </reference>
 
       </reference>
 
   </observation>
 
   </observation>
 +
</entry>
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
Consent directives <observation> shall be represented as shown above. They SHOULD NOT contain any <repeatNumber>, <interpretationCode>, <value>, <methodCode> or <targetSiteCode> elements.
 
Consent directives <observation> shall be represented as shown above. They SHOULD NOT contain any <repeatNumber>, <interpretationCode>, <value>, <methodCode> or <targetSiteCode> elements.
  
;<templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.13'/><br><templateId root='1.2.276.0.76.3.1.81.81.6.4.1'/>
 
:The <templateId> elements shown above MUST be present, and indicate that this is a Consent Directive entry.
 
  
 +
{| class="hl7table"
 +
! Lvl
 +
! RIM
 +
! Name
 +
! Desc
 +
! DT
 +
! Kard
 +
! Conf
 +
! Beschreibung
 +
 +
|-
 +
|1
 +
|bgcolor="ff8888"|act
 +
|entry
 +
|
 +
|
 +
|
 +
|
 +
 +
|-
 +
|2
 +
|bgcolor="ff8888"|act
 +
|observation
 +
|
 +
|
 +
|
 +
|
 +
 +
|-
 +
|3
 +
|bgcolor="ff8888"|act
 +
|templateID
 +
|
 +
|
 +
|
 +
|
 +
|eindeutige Identifikation dieses Templates
 +
 +
|-
 +
|4
 +
|bgcolor="ff8888"|act
 +
|root
 +
|
 +
|
 +
|
 +
|
 +
|fix: 1.3.6.1.4.1.19376.1.5.3.1.4.13, 1.2.276.0.76.3.1.81.81.6.4.1<br>
 +
The <templateId> elements shown above MUST be present, and indicate that this is a Consent Directive entry.
 +
 +
 +
|-
 +
|3
 +
|bgcolor="ff8888"|act
 +
|id
 +
|
 +
|
 +
|
 +
|
 +
|
 +
 +
|-
 +
|3
 +
|bgcolor="ff8888"|act
 +
|code
 +
|
 +
|
 +
|
 +
|
 +
|
 
;&lt;code code='A|R|P|X' displayName='Active|Refused|Pending|Rescinded' codeSystem='2.16.840.1.113883.12.498' codeSystemName='HL7 Consent Status'/>
 
;&lt;code code='A|R|P|X' displayName='Active|Refused|Pending|Rescinded' codeSystem='2.16.840.1.113883.12.498' codeSystemName='HL7 Consent Status'/>
 
:This code records the status of the consent:
 
:This code records the status of the consent:
Zeile 61: Zeile 143:
 
:* Refused (code=’R’): If a pending consent is rejected or not confirmed the state of the consent is set to ‘R’. The eCR MUST immediately be closed and all copies of medical documents within the eCR MUST be deleted.
 
:* Refused (code=’R’): If a pending consent is rejected or not confirmed the state of the consent is set to ‘R’. The eCR MUST immediately be closed and all copies of medical documents within the eCR MUST be deleted.
  
 +
|-
 +
|3
 +
|bgcolor="ff8888"|act
 +
|value
 +
|
 +
|
 +
|
 +
|
 +
|
 
;<value xsi&#58;type='CD' code=' ' displayName=' ' codeSystem='1.2.276.0.76.3.1.81.81.5.1' codeSystemName='eCR Consent Authorization Code'/>
 
;<value xsi&#58;type='CD' code=' ' displayName=' ' codeSystem='1.2.276.0.76.3.1.81.81.5.1' codeSystemName='eCR Consent Authorization Code'/>
 
:This element records the permissions that have been gratend (or revoked) by the consent. It MUST be typed as “CD”.  
 
:This element records the permissions that have been gratend (or revoked) by the consent. It MUST be typed as “CD”.  
Zeile 67: Zeile 158:
 
:Other code systems than the “[[cdaefa:1.2.276.0.76.3.1.81.81.5.1|eCR Consent Authorization]]” code system MAY be used.
 
:Other code systems than the “[[cdaefa:1.2.276.0.76.3.1.81.81.5.1|eCR Consent Authorization]]” code system MAY be used.
  
 +
|-
 +
|3
 +
|bgcolor="ff8888"|act
 +
|text
 +
|
 +
|
 +
|
 +
|
 +
|
 
;<text><reference value='#xxx'/></text>
 
;<text><reference value='#xxx'/></text>
 
:SHOULD contain a reference to the narrative description of the given consent that is provided in the section’s <text> element. Alternatively the description of the consent MAY be directly given within this element.  
 
:SHOULD contain a reference to the narrative description of the given consent that is provided in the section’s <text> element. Alternatively the description of the consent MAY be directly given within this element.  
  
 +
|-
 +
|3
 +
|bgcolor="ff8888"|act
 +
|effectiveTime
 +
|
 +
|
 +
|
 +
|
 +
|
 
;<effectiveTime><low value='YYYYMMDD' /><high value='YYYYMMDD'/></effectiveTime>   
 
;<effectiveTime><low value='YYYYMMDD' /><high value='YYYYMMDD'/></effectiveTime>   
 
:The start and end date of the consent validity MUST be provided by an <effectiveTime> element. The eCR managing system MUST ensure that the consent validity time span is within the maximum validity time span of an eCR (as stated in the eCR privacy concept).  
 
:The start and end date of the consent validity MUST be provided by an <effectiveTime> element. The eCR managing system MUST ensure that the consent validity time span is within the maximum validity time span of an eCR (as stated in the eCR privacy concept).  
  
 +
|-
 +
|3
 +
|bgcolor="ff8888"|act
 +
|author
 +
|
 +
|
 +
|
 +
|
 +
|
 
;<author>
 
;<author>
 
:The person to whom the consent was given MUST be recorded in a single <author> element.
 
:The person to whom the consent was given MUST be recorded in a single <author> element.
  
 +
|-
 +
|4
 +
|bgcolor="ff8888"|act
 +
|time
 +
|
 +
|
 +
|
 +
|
 +
|
 
;<time value=' '/>
 
;<time value=' '/>
 
The time of the consent form creation shall be recorded in the <time> element.  At least YYYYMMDD MUST be provided.
 
The time of the consent form creation shall be recorded in the <time> element.  At least YYYYMMDD MUST be provided.
  
 +
|-
 +
|4
 +
|bgcolor="ff8888"|act
 +
|assignedAuthor
 +
|
 +
|
 +
|
 +
|
 +
|
 
;<assignedAuthor>
 
;<assignedAuthor>
 
:The assigned author MUST be encoded using the Assigned Human Entity Content Module ([[cdaefa:1.2.276.0.76.3.1.81.81.6.2.2|1.2.276.0.76.3.1.81.81.6.2.2]]).
 
:The assigned author MUST be encoded using the Assigned Human Entity Content Module ([[cdaefa:1.2.276.0.76.3.1.81.81.6.2.2|1.2.276.0.76.3.1.81.81.6.2.2]]).
 +
 +
|}
 +
  
 
== Example ==
 
== Example ==
Zeile 203: Zeile 342:
 
The <id> element MUST contain the local identifier of the document. The document processor MAY replace this identifier with a newly assigned id. In case that the document is not assigned a local identifier the <id> element MUST be marked with a NullFlavor of ‘UNK’.
 
The <id> element MUST contain the local identifier of the document. The document processor MAY replace this identifier with a newly assigned id. In case that the document is not assigned a local identifier the <id> element MUST be marked with a NullFlavor of ‘UNK’.
 
Consent document MUST always be given as uncompressed base64 encoded data.
 
Consent document MUST always be given as uncompressed base64 encoded data.
 +
 +
 +
[[Kategorie:CDA Entry Level Template|Consent Directive Observation (Entry)]]

Aktuelle Version vom 8. Februar 2013, 15:42 Uhr

Dieses Material ist Teil des Leitfadens CDA für die elektronische Fallakte.
  • Direkt im Wiki geändert werden sollten Schreibfehler, ergänzende Hinweise.
  • Offene Fragen, die der Diskussionen bedürfen, sollten auf der Diskussionsseite aufgenommen werden.
  • Liste der Seiten dieses Leitfadens: hier, Liste der Seiten, in denen dieses Material verwendet (transkludiert) siehe hier .

Entry: Consent Directive Observation (Entry)

Template ID 1.2.276.0.76.3.1.81.81.6.4.1
General Description Hiermit wird auf Entry-Level die Übermittlung von Einwilligungsdetails definiert.
LOINC Code Opt. Description
???? O


A consent directive observation is a specialization of the IHE PCC simple observation content module (1.3.6.1.4.1.19376.1.5.3.1.4.13) that uses a specific vocabulary.

Standards

Template

<entry>
   <observation typeCode='OBS' moodCode='EVN'>
      <templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.13'/>
      <templateId root='1.2.276.0.76.3.1.81.81.6.4.1'/>
      <id root=' ' extension=' '/>
      <code code='A|R|P|X' displayName='Active|Refused|Pending|Rescinded' 
               codeSystem='2.16.840.1.113883.12.498' 
               codeSystemName='HL7 Consent Status'/>
      <!-- scope of the consent (e.g. as defined by eCR Consent Authorization Codes -->
      <value xsi:type='CD' code=' ' displayName=' ' 
                           codeSystem='1.2.276.0.76.3.1.81.81.5.1' 
                           codeSystemName='eCR Consent Authorization Code'/>
      <text><reference value='#xxx'/></text>
      <statusCode code='completed'/>
      <effectiveTime>
         <low value='YYYYMMDD'/>
         <high value='YYYYMMDD'/>
      </effectiveTime>  
      <author>
         <time value=''/>
         <assignedAuthor>
            <templateId root='1.2.276.0.76.3.1.81.81.6.2.2'/> 
            <id root='' extension=''>
            <addr></addr>
            <telecom value='' use=''>
            <assignedPerson><name></name></assignedPerson>
            <representedOrganization><name></name></representedOrganization>
         </assignedAuthor>
      </author>    
      <reference typeCode='REFR'>
         <templateId root='2.16.840.1.113883.10.20.1.36'/>
         <externalDocument classCode='DOC' moodCode='EVN'>
            <id root='...' extension='...'/>
            <code code="59284-0" codeSystem="2.16.840.1.113883.6.1" 
      		  codeSystemName="LOINC" displayName="Consent"/>
            <text><reference value='...'/></text>
         </externalDocument>
      </reference>
   </observation>
</entry>

Consent directives <observation> shall be represented as shown above. They SHOULD NOT contain any <repeatNumber>, <interpretationCode>, <value>, <methodCode> or <targetSiteCode> elements.


Lvl RIM Name Desc DT Kard Conf Beschreibung
1 act entry
2 act observation
3 act templateID eindeutige Identifikation dieses Templates
4 act root fix: 1.3.6.1.4.1.19376.1.5.3.1.4.13, 1.2.276.0.76.3.1.81.81.6.4.1

The <templateId> elements shown above MUST be present, and indicate that this is a Consent Directive entry.


3 act id
3 act code
<code code='A|R|P|X' displayName='Active|Refused|Pending|Rescinded' codeSystem='2.16.840.1.113883.12.498' codeSystemName='HL7 Consent Status'/>
This code records the status of the consent:
  • Active (code=’A’): The patient has given consent to using an eCR to support his treatment. Authorized users can read and write data to an eCR according to their roles.
  • Rescinded (code=’X’): The patient has revoked his consent for using an eCR. During the grace period authorized users MAY still read the eCR in order to create copies for their internal documentation. The minimum and maximum duration of the grace period MUST be defined by the privacy concept of the eCR provider.
  • Pending (code=’P’): Consent has not been sought (e.g. because the patient was uncautious) or has been asked but not been confirmed until now. In this state users MAY write documents to the eCR but MUST NOT read the eCR. The maximum duration of a pending status MUST be defined by the privacy concept of the eCR provider.
  • Refused (code=’R’): If a pending consent is rejected or not confirmed the state of the consent is set to ‘R’. The eCR MUST immediately be closed and all copies of medical documents within the eCR MUST be deleted.
3 act value
<value xsi:type='CD' code=' ' displayName=' ' codeSystem='1.2.276.0.76.3.1.81.81.5.1' codeSystemName='eCR Consent Authorization Code'/>
This element records the permissions that have been gratend (or revoked) by the consent. It MUST be typed as “CD”.
Multiple <value> elements MAY be used to record multiple permissions. Each <value> element SHOULD use one of the codes listed in table eCR Consent Authorization Code (1.2.276.0.76.3.1.81.81.5.1).
If this element is omitted, ‘USE’ is assumed to be the permission assigned (or revoked) with the registered consent document.
Other code systems than the “eCR Consent Authorization” code system MAY be used.
3 act text
<text><reference value='#xxx'/></text>
SHOULD contain a reference to the narrative description of the given consent that is provided in the section’s <text> element. Alternatively the description of the consent MAY be directly given within this element.
3 act effectiveTime
<effectiveTime><low value='YYYYMMDD' /><high value='YYYYMMDD'/></effectiveTime>
The start and end date of the consent validity MUST be provided by an <effectiveTime> element. The eCR managing system MUST ensure that the consent validity time span is within the maximum validity time span of an eCR (as stated in the eCR privacy concept).
3 act author
<author>
The person to whom the consent was given MUST be recorded in a single <author> element.
4 act time

The time of the consent form creation shall be recorded in the

4 act assignedAuthor
<assignedAuthor>
The assigned author MUST be encoded using the Assigned Human Entity Content Module (1.2.276.0.76.3.1.81.81.6.2.2).


Example

   <entry>
	<templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.13'/>
	<templateId root='1.2.276.0.76.3.1.81.81.6.4.1'/>

	<observation typeCode='OBS' moodCode='EVN'>
		<templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.13'/>
		<templateId root='1.2.276.0.76.3.1.81.81.6.4.1'/>
    
		<id root='1.1.1.1' extension='consent-1'/>

<!-- the consent is active; documents may be registered and read -->
		<code code='P' displayName='Active' 
					codeSystem='2.16.840.1.113883.12.498' 
    					codeSystemName='HL7 Consent Status'/>

<!-- the consent allows for regular eCR use and allows eCR participants to autonomously
     Link visits to the eCR -->
		<value xsi:type='CD' code='SETUP' displayName='Setup and Use' 
				codeSystem='1.2.276.0.76.3.1.81.81.5.1' 
				codeSystemName='eCR Consent Authorization Code'/>
		<value xsi:type='CD' code='ENCLINK' displayName='Encounter Linkage' 
				codeSystem='1.2.276.0.76.3.1.81.81.5.1' 
				codeSystemName='eCR Consent Authorization Code'/>

		<text><reference value='#id-2'/></text>

		<statusCode code='completed'/>

<!-- the consent is valid for 2 years -->
		<effectiveTime>
				<low value='20110909'/>
				<high value='20130909'/>
		</effectiveTime>  

<!-- the consent was given to the identified physician on Sept. 9. 2011 -->
		<author>
			<time value="20110909"/>
			<assignedAuthor>
				<templateId root='1.2.276.0.76.3.1.81.81.6.2.2'/>
				<id extension='HPC-Physician-2' root='1.2.276.0.76.4.75'/>
				&lt;code code='1.2.276.0.76.4.30' displayName='arzt-ghcs'/>
				...
			</assignedAuthor>
		</author>

<!-- reference to the consent, see following sections for examples -->
		<reference typeCode='REFR'>
			<templateId root='2.16.840.1.113883.10.20.1.36'/>
			...
    			<code code="59284-0" codeSystem="2.16.840.1.113883.6.1" 
      		              codeSystemName="LOINC" displayName="Consent"/>
			...
		</reference>
	</observation>
   </entry>

Reference to a Consent that is stored as a Document

If the consent is available as a digital document within a Document Repository the reference points to the information object that represents the consent.

   <reference typeCode='REFR'>
      <templateId root='2.16.840.1.113883.10.20.1.36'/>
      <externalDocument classCode='DOC' moodCode='EVN'>
         <id root=' ' extension=' '/>
         <code code="59284-0" codeSystem="2.16.840.1.113883.6.1" 
   		  codeSystemName="LOINC" displayName="Consent"/>
         <text />
      </externalDocument>
   </reference>

For digitally signed consents and scanned consent documents that are stored in a document repository, the consent directive observation MUST contain a single reference to an external document. The <id> element MUST contain the appropriate root and extension attributes to identify the consent document. Within a Consent Update document a user may change the care team setup based on an existing consent (e.g. in cases where a consent with an eCR Consent Authorization Code of ‘PARTMGMT’ is already registered). In this case the <externalDocument> MUST either explicitly refer to this consent (via <id>) or mark the identifier as existent but unknown (<id NullFlavor=”UNK”/>). If the identifier is nullified, the document processor SHOULD search for a matching consent and replace the nullified identfier with a reference to the respective consent.

   <reference typeCode='REFR'>
      <templateId root='2.16.840.1.113883.10.20.1.36'/>
      <externalDocument classCode='DOC' moodCode='EVN'>
   <!-- eCR Box will search for a matching consent -->
         <id NullFlavor="UNK" />
         <code code="59284-0" codeSystem="2.16.840.1.113883.6.1" 
   		  codeSystemName="LOINC" displayName="Consent"/>
      </externalDocument>
   </reference>

Registration of a Paper Consent

For paper consents with wet signatures the <reference> element MUST contain an <externalDocument> element with an identifier that is nullified by a @NullFlavor value of ‘NA’.

   <reference typeCode='REFR' >
      <templateId root='2.16.840.1.113883.10.20.1.36'/>
      <externalDocument classCode='DOC' moodCode='EVN'>
         <id NullFlavor='NA' />
         <code code="59284-0" codeSystem="2.16.840.1.113883.6.1" 
                  codeSystemName="LOINC" displayName="Consent"/>
      </externalDocument>
   </reference>

Registration and Upload of a Digital Consent

Base64 encoded consent document can be included within the <text> element.

   <reference typeCode='REFR' >
      <templateId root='2.16.840.1.113883.10.20.1.36'/>
      <externalDocument classCode='DOC' moodCode='EVN'> 
         <id root=' ' extension=' '/>
         <code code="59284-0" codeSystem="2.16.840.1.113883.6.1" 
   		   codeSystemName="LOINC" displayName="Consent"/>
         <text representation=’B64’>Base64 encoded document</text>
      </externalDocument>
   </reference>

The <id> element MUST contain the local identifier of the document. The document processor MAY replace this identifier with a newly assigned id. In case that the document is not assigned a local identifier the <id> element MUST be marked with a NullFlavor of ‘UNK’. Consent document MUST always be given as uncompressed base64 encoded data.