Difference between revisions of "TF-PCC-CP-0030"

Revision as of 17:04, 19 June 2008

Return to: PCC_Change_Proposals
Return to: PCC_TF-1/PHLAB
Return to: PCC_TF-1/PHLAB/XDSLAB_Harmonization

Change Proposal TF-PCC-CP-0030

Official Change Proposal Template is a WORD document found at ftp://ftp.ihe.net/Document_templates/IHE_Change_Proposal-Template-V10.doc

The Change Proposal Template that you use is dependent on the committee.

Tracking Information

Domain: Patient Care Coordination
Change Proposal Number: TF-PCC-CP-0030
Status: incoming
Last Updated: 17:04, 19 June 2008 (CDT)
Assigned: Unassigned

Change Proposal Summary

Title: Edits to XD* Metadata Bindings
Submission Date: 17:04, 19 June 2008 (CDT)
Profile Affected: PCC-TF
TF Version: 2024
Volume and Section

Rationale

Binding edits for clarity and to reduce implementation confusion are recommended below in red. Summary of edits: 1) moved all explainations of value to the 'Source/Value' column so exceptions to the x-path(ex. patientId) are more easily identified, wording suggestions; 2) updated source type; 3) added intended recipient (XDR);

Content

media:cp.doc

Medical Document Binding to XDS, XDM and XDR

This binding defines a transformation that generates metadata for the XDSDocumentEntry element of appropriate transactions from the XDS, XDM and XDR profiles given a medical document and information from other sources. The medical document refers to the document being stored in a repository that will be referenced in the registry. The other sources of information include the configuration of the Document Source actor, the Affinity Domain, the site or facility, local agreements, other documents in the registry/repository, and this Content Profile.

XDSDocumentEntry Metadata

XDSDocumentEntry Attribute	Optional?	Source Type	Source/ Value
availabilityStatus	R	DS
authorInstitution	R2	SAT	$inst <= /ClinicalDocument/author /assignedAuthor /representedOrganization The authorInstitution can be formated using the following XPath expression, where $inst in the expression below represents the representedOrganization. concat($inst/id/@extension, "^", $inst/name, "^^^^^^^&", $inst/id/@root, "&ISO")
authorPerson	R2	SAT	$person <= /ClinicalDocument/author The author can be formatted using the following XPath expression, where $person in the expression below represents the author. concat( $person/id/@extension,"^", $person/assignedPerson/name/family,"^", $person/assignedPerson/name/given[1],"^", $person/assignedPerson/name/given[2],"^", $person/assignedPerson/name/suffix,"^", $person/assignedPerson/name/prefix,"^", $person/assignedPerson/name/degree,"^^&", $person/id/@root,"&ISO")
authorRole	R2	SAT	This metadata element should be based on a mapping of the participation function defined in the CDA document to the set of author roles configured for the affinity domain. If the context of the CDA coincides with that of the affinity domain, then the following x-path may be appropriate: /ClincicalDocument/author/ participationFunction
authorSpecialty	R2	SAT	This metadata element should be based on a mapping of the code associated with the assignedAuthor to detailed defined classification system for healthcare providers such configured in the affinitity domain. Possible classifications include those found in SNOMED-CT, or the HIPAA Healthcare Provider Taxonomy. If the context of the CDA coincides with that of the affinity domain, then the following x-path may be appropriate: /ClinicalDocument/author/ assignedAuthor/code
classCode Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual).	R	CADT	Must be consistent with /ClinicalDocument/code/@code
classCodeDisplayName DisplayName of the classCode derived. Derived from a mapping of /ClinicalDocument/code/@code to the appropriate Display Name based on the Type of Service.	R	CADT	Must be Consitent with /ClinicalDocument/code/@code
confidentialityCode Derived from a mapping of /ClinicalDocument/confidentialityCode/@code to an Affinity Domain specified coded value and coding system. When using the BPPC profile, the confidentialyCode may also be obtained from the <authorization> element.	R	CADT	/ClinicalDocument/ confidentialityCode/@code -AND/OR- /ClinicalDocument/authorization/ consent[ templateId/@root= '1.3.6.1.4.1.19376.1.5.3.1.2.5' ] /code/@code
comments	O	DS
creationTime Times specified in clinical documents may be specified with a precision in fractional sections, and may contain a time zone offset. In the XDS Metadata, it can be precise to the second, and is always given in UTC, so the timezone offset if present must be added to the current time to obtain the UTC time.	R	SAT	/ClinicalDocument/effectiveTime
entryUUID	R	DS
eventCodeList These values express a collection of keywords that may be relevant to the consumer of the documents in the registry. They may be mapped from the service event code found in the clinical document.	O	CADT	/ClinicalDocument/documentationOf/ serviceEvent/code
eventCodeDisplayNameList These are the display names for the collection of keywords described above.	R (if event Code is valued)	CADT
formatCode The format code for each PCC Document content profile is provided within the document specifications.	R	FM
healthcareFacilityTypeCode A fixed value assigned to the Document Source and configured form a set of Affinity Domain defined values.	R	CAD	Must be concistent with /clinicalDocument/code
healthcareFacility TypeCodeDisplay Name	R	CAD	Must be concistent with /clinicalDocument/code

languageCode	R	SA	/ClinicalDocument/languageCode
legalAuthenticator The legalAuthenticator can be formatted using the following XPath expression, where $person in the expression below represents the legalAuthenticator. concat( $person/id/@extension,"^", $person/assignedPerson/name/family,"^", $person/assignedPerson/name/given[1],"^", $person/assignedPerson/name/given[2],"^", $person/assignedPerson/name/suffix,"^", $person/assignedPerson/name/prefix,"^", $person/assignedPerson/name/degree,"^^&", $person/id/@root,"&ISO" )	O	SAT	$person <= /ClinicalDocument/ legalAuthenticator
mimeType	R	FM	text/xml
parentDocumentRelationship Local document versions need not always be published, and so no exact mapping can be determined from the content of the CDA document. The parentDocumentRelationship may be determined in some configurations from the relatedDocument element present in the CDA dsocument.	R (when applicable)	DS	/ClinicalDocument/relatedDocument/@typeCode
parentDocumentId Local document versions need not always be published, and so no exact mapping can be determined from the content of the CDA document. The parentDocumentId may be determined in some configurations from the relatedDocument element present in the CDA dsocument. The parentDocumentId can be formatted using the following XPath expression, where $docID in the expression below represents the identifier. concat($docID/@root,"^", $docID/@extension)	R (when parent Document Relationship is present)	DS	$docID <= /ClinicalDocument/ relatedDocument/parentDocument/ id
patientId The XDS Affinity Domain patient ID can be mapped from the patientRole/id element using transactions from the ITI PIX or PDQ profiles. See sourcePatientId below.	R	SAT	$patID <= /ClinicalDocument/recordTarget/ patientRole/id
practiceSettingCode This elements should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.	R	CAD
practiceSettingCodeDisplayName This element shall contain the display names associated with the codes described above.	R	CAD
serviceStartTime Times specified in clinical documents may be specified with a precision in fractional sections, and may contain a time zone offset. In the XDS Metadata, it can be precise to the second, and is always given in UTC, so the timezone offset if present must be added to the current time to obtain the UTC time.	R2	SAT	/ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/low/ @value
serviceStopTime Times specified in clinical documents may be specified with a precision in fractional sections, and may contain a time zone offset. In the XDS Metadata, it can be precise to the second, and is always given in UTC, so the timezone offset if present must be added to the current time to obtain the UTC time.	R2	SAT	/ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/high/ @value
sourcePatientId The patientId can be formatted using the following XPath expression, where $patID in the expression below represents the appropriate identifier. concat($patID/@extension,"^^^&", $patID/@root, "&ISO")	R	SAT	$patID <= /ClinicalDocument/recordTarget/ patientRole/id
sourcePatientInfo The sourcePatientInfo metadata element can be assembled from various components of the patientRole element in the clinical document.	R	SAT	/ClinicalDocument/recordTarget/ patientRole
title	O	SA	/ClinicalDocument/title
typeCode The typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted.	R	CADT	/ClinicalDocument/code/@code
typeCodeDisplay Name	R	CADT	/ClinicalDocument/code/@displayName
uniqueId The uniqueId can be formatted using the following XPath expression, where $docID in the expression below represents the identifier. concat($docID/@root,"^", $docID/@extension)	R	SAT	$docID <= /ClinicalDocument/id

XDSSubmissionSet Metadata

The submission set metadata is as defined for XDS, and is not necessarily affected by the content of the clinical document. Metadata values in an XDSSubmissionSet with names identical to those in the XDSDocumentEntry may be inherited from XDSDocumentEntry metadata, but this is left to affinity domain policy and/or application configuration.

Use of XDS Submission Set

This content format uses the XDS Submission Set to create a package of information to send from one provider to another. All documents referenced by the Medical Summary in this Package must be in the submission set.

Use of XDS Folders

No specific requirements identified.

Configuration

IHE Content Profiles using this binding require that Content Creators and Content Consumers be configurable with institution and other specific attributes or parameters. Implementers should be aware of these requirements to make such attributes easily configurable. There shall be a mechanism for the publishing and distribution of style sheets used to view clinical documents.

@@ Line 4: / Line 4: @@
 <br>
 Return to: [[PCC_TF-1/PHLAB/XDSLAB_Harmonization]]
+==Change Proposal {{PAGENAME}} ==
+Official Change Proposal Template is a WORD document found at ftp://ftp.ihe.net/Document_templates/IHE_Change_Proposal-Template-V10.doc
+The Change Proposal Template that you use is dependent on the committee.
+===Tracking Information===
+; Domain : [[Patient Care Coordination]]
+; Change Proposal Number : {{PAGENAME}}
+; Status : incoming
+; Last Updated : 17:04, 19 June 2008 (CDT)
+; Assigned : Unassigned
+=== Change Proposal Summary ===
+; Title : Edits to XD* Metadata Bindings
+; Submission Date:  17:04, 19 June 2008 (CDT)
+; Profile Affected: PCC-TF
+; TF Version: {{CURRENTYEAR}}
+; Volume and Section:
+=== Rationale ===
+Binding edits for clarity and to reduce implementation confusion are recommended below in red. Summary of edits: 1) moved all explainations of value to the 'Source/Value' column so exceptions to the x-path(ex. patientId) are more easily identified, wording suggestions; 2) updated source type; 3) added intended recipient (XDR);
+=== Content ===
+[[media:cp.doc]]
+[[Category:Change Proposal]]
+[[Category:Patient Care Coordination]]
 ===Medical Document Binding to XDS, XDM and XDR===
@@ Line 21: / Line 52: @@
 |&nbsp;
 |-
-|authorInstitution<br/>The authorInstitution can be formated<br/>using the following XPath expression, where '''$inst''' in the expression below represents the representedOrganization.<br/>concat($inst/id/@extension, "<nowiki>^</nowiki>",<br/>$inst/name, "<nowiki>^^^^^^^</nowiki>&",<br/>$inst/id/@root, "&ISO"<br/>)
+|authorInstitution
 |align = "center"|R2
 |align = "center"|SAT
-|$inst <nowiki><</nowiki>= /ClinicalDocument/author<br/>/assignedAuthor<br/>/representedOrganization
+|
+$inst <nowiki><</nowiki>=
+/ClinicalDocument/author<br/>/assignedAuthor<br/>/representedOrganization
+<br/><br/>
+<font color="red">
+The authorInstitution can be formated<br/>using the following XPath expression, where '''$inst''' in the expression below represents the representedOrganization.<br/>concat($inst/id/@extension, "<nowiki>^</nowiki>",<br/>$inst/name, "<nowiki>^^^^^^^</nowiki>&",<br/>$inst/id/@root, "&ISO")<br/>
+</font>
 |-
-|authorPerson<br/>The author can be formatted using the following XPath expression, where '''$person''' in the expression below represents the author.<br/>concat(<br/>  $person/id/@extension,"<nowiki>^</nowiki>",<br/>  $person/assignedPerson/name/family,"<nowiki>^</nowiki>",<br/>  $person/assignedPerson/name/given<nowiki>[</nowiki>1<nowiki>]</nowiki>,"<nowiki>^</nowiki>",<br/>  $person/assignedPerson/name/given<nowiki>[</nowiki>2<nowiki>]</nowiki>,"<nowiki>^</nowiki>",<br/>  $person/assignedPerson/name/suffix,"<nowiki>^</nowiki>",<br/>  $person/assignedPerson/name/prefix,"<nowiki>^</nowiki>",<br/>  $person/assignedPerson/name/degree,"<nowiki>^^</nowiki>&",<br/>  $person/id/@root,"&ISO"<br/>)
+|authorPerson
 |align = "center"|R2
 |align = "center"|SAT
-|$person <nowiki><</nowiki>= /ClinicalDocument/author
+|
+$person <nowiki><</nowiki>= /ClinicalDocument/author
+<br/><br/>
+<font color="red">
+The author can be formatted using the following XPath expression, where '''$person''' in the expression below represents the author.<br/>concat(<br/>  $person/id/@extension,"<nowiki>^</nowiki>",<br/>  $person/assignedPerson/name/family,"<nowiki>^</nowiki>",<br/>  $person/assignedPerson/name/given<nowiki>[</nowiki>1<nowiki>]</nowiki>,"<nowiki>^</nowiki>",<br/>  $person/assignedPerson/name/given<nowiki>[</nowiki>2<nowiki>]</nowiki>,"<nowiki>^</nowiki>",<br/>  $person/assignedPerson/name/suffix,"<nowiki>^</nowiki>",<br/>  $person/assignedPerson/name/prefix,"<nowiki>^</nowiki>",<br/>  $person/assignedPerson/name/degree,"<nowiki>^^</nowiki>&",<br/>  $person/id/@root,"&ISO")<br/>
+</font>
 |-
-|authorRole<br/>This metadata element should be based on a mapping of the participation function defined in the CDA document to the set of author roles configured for the affinity domain.
+|authorRole
 |align = "center"|R2
 |align = "center"|SAT
-|/ClincicalDocument/author/<br/>participationFunction
+|<font color="red">This metadata element should be based on a mapping of the participation function defined in the CDA document to the set of author roles configured for the affinity domain. If the context of the CDA coincides with that of the affinity domain, then the following x-path may be appropriate: <br/>/ClincicalDocument/author/<br/>participationFunction
+</font>
 |-
-|authorSpecialty<br/>This metadata element should be based on a mapping of the code associated with the assignedAuthor to detailed defined classification system for healthcare providers such configured in the affinitity domain.  Possible classifications include those found in SNOMED-CT, or the HIPAA Healthcare Provider Taxonomy.
+|authorSpecialty
 |align = "center"|R2
 |align = "center"|SAT
-|/ClinicalDocument/author/<br/>assignedAuthor/code
+|<font color="red">This metadata element should be based on a mapping of the code associated with the assignedAuthor to detailed defined classification system for healthcare providers such configured in the affinitity domain.  Possible classifications include those found in SNOMED-CT, or the HIPAA Healthcare Provider Taxonomy. If the context of the CDA coincides with that of the affinity domain, then the following x-path may be appropriate: <br/>/ClinicalDocument/author/<br/>assignedAuthor/code
+</font>
 |-
 |classCode<br/>Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User<nowiki>'</nowiki>s Manual).