For Discussion and Demonstration Only The Normative content for these specifications may be found on the HL7, IHE, and HITSP web sites.

Exchange Profile

[ClinicalDocument: templateId 2.16.840.1.113883.3.3251.3]

The following are the constraints applied to the Document Sharing (aka XDS) Metadata
          used by the NwHIN SOAP (Exchange) Implementations (e.g. IHE XDR Integration Profile). This
          profile specifies constraints applied to the basic/core Document Sharing Metadata specified
          in the IHE IT Infrastructure Technical Framework - Volume 3
          (http://www.ihe.net/Technical_Framework/upload/IHE_ITI_TF_Vol3.pdf). The metadata described in here was constrained to support the needs of the DS4P project as specified in the introduction to this document.

  1. SHALL contain exactly one [1..1] templateId ( CONF-DS4P-E-1 ) such that it
    1. SHALL contain exactly one [1..1] @root="2.16.840.1.113883.3.3251.3"
  2. SHALL conform to CONTENTPROFILE cda Privacy Segmented Document template (templateId: 2.16.840.1.113883.3.3251.1.1) (CONF:16808)
  3. SHOULD contain [0..*] component (CONF:14907)
    • The Obligation Policy Code is carried on the documentEntry.confidentialityCode metadata element of the Document Sharing Metadata. This
      is an optional code that is needed in certain situations. If obligation policy code is not populated, the
      receiving system will handle the information using its default behavior. The sender has the opportunity to
      specify the receiver's handling of the data.  The sender may specify one or more "obligation" codes.

    1. Contains exactly one [1..1] eb XML Registry Classification Obligation Policy (templateId: 2.16.840.1.113883.3.3251.1.22)
  4. SHALL contain [1..*] component (CONF:14908)
    • The Purpose of Use Code is carried on the documentEntry.confidentialityCode metadata element of the Document Sharing Metadata.
      This is an optional code that is needed in certain situations. If no Purpose of  Use code is populated, the
      receiving system will handle the information using its default behavior.  One or more purposes may be specified by the sender.

    1. Contains exactly one [1..1] eb XML Registry Classification Purpose Of Use (templateId: 2.16.840.1.113883.3.3251.1.23)
  5. SHOULD contain [0..*] component (CONF:14909)
    • The Refrain Policy Code is carried on the documentEntry.confidentialityCode metadata element of the Document Sharing Metadata.
      This is an optional code that is needed in certain situations. If this metadata is not populated, the receiving system will handle the information using
      its default behavior. The sender has the opportunity to specify the receiver's handling of the data. The sender may specify more than one refrain policies.

    1. Contains exactly one [1..1] eb XML Registry Classification Refrain Policy (templateId: 2.16.840.1.113883.3.3251.1.24)
  6. SHALL contain [1..1] component (CONF:14910)
    • The DocumentEntry.healthcareFacilityTypeCode is a mandatory Document Sharing Metadata element. This element is constrained specifically to conform with the requirement of the DS4P project related to the need to control disclosure of protected information.

    1. Contains exactly one [1..1] eb XML Registry Classification Healthcare Facility Type Code (templateId: 2.16.840.1.113883.3.3251.3.1.2)
  7. SHALL contain [1..1] component (CONF:14911)
    • The DocumentEntry.practiceSettingCode is a mandatory Document Sharing Metadata
      element. This element is constrained specifically to conform with privacy policies
                  related to the type of practice setting information that may be reported in the registry
                  metadata.  If this metadata is not populated, the receiving system will handle the information using its default behavior. The sender has the opportunity to specify the receiver's handling of the data.

    1. Contains exactly one [1..1] eb XML Registry Classification Practice Setting Code (templateId: 2.16.840.1.113883.3.3251.3.1.3)
  8. SHALL contain [1..1] component (CONF:14912)
    • The DocumentEntry.typeCode is a mandatory Document Sharing Metadata element. This
      element is constrained specifically to conform with privacy policies related to the type
      of document kind details that may be reported in the registry metadata..

    1. Contains exactly one [1..1] eb XML Registry Classification Type Code (templateId: 2.16.840.1.113883.3.3251.3.1.4)
  9. SHALL contain [1..*] intendedRecipient (CONF:16806)
    • If the SubmissionSet.intendedRecipient is specified, then the intended recipient's email is a mandatory element intended to support communication across NwHIN SOAP/Exchange based on IHE XDR and DIRECT implementations using IHE XDM. Typically, protected information is directed to one or more recipients.

    1. Contains exactly one [1..1] eb XML Registry Slot Intended Recipient (templateId: 2.16.840.1.113883.3.3251.3.1.6)
  10. SHALL contain [1..1] component (CONF:16807)
    • The SubmissionSet.author must include the sender's email to support communication across NwHIN SOAP/Exchange
      and Direct implementations. This is also important for establishing the provenance of
      documents registered in XDS registries hosted by provider and jurisdictional
      organizations.

    1. Contains exactly one [1..1] eb XML Registry Classification Author Telecommunication (templateId: 2.16.840.1.113883.3.3251.3.1.1)

Exchange Profile example

        
<!-- authorTelecommunication comes from the From header.
                            It must be prepended with ^^Internet^ -->
                        <rim:Classification id="cl08"
                            classificationScheme="urn:uuid:a7058bb9-b4e4-4307-ba5b-e3f0ab85e12d"
                            classifiedObject="SubmissionSet01">
                            <rim:Slot name="authorTelecommunication">
                                <rim:ValueList>
                                    <rim:Value>>^^Internet^drjones@direct.sunnyfamily.example.org</rim:Value>
                                </rim:ValueList>
                            </rim:Slot>
                        </rim:Classification>
                        <!-- Required Healthcare Facility Type Code -->
                         <rim:Classification id="cl-$doc1-5" classificationScheme="urn:uuid:f33fb8ac-18af-42cc-ae0e-ed0b0bdb91e1"
                                classifiedObject="$doc1" nodeRepresentation="Outpatient">
                <rim:Slot name="codingScheme">
                    <rim:ValueList>
                        <rim:Value>2.16.840.1.113883.3.3251.3.2.1</rim:Value>
                    </rim:ValueList>
                </rim:Slot>
                <rim:Name>
                    <rim:LocalizedString value="Outpatient"/>
                </rim:Name>
            </rim:Classification>
            	<!-- Required Practice Setting -->
			<Classification 
				id="urn:uuid:fb57bcf4-7f7a-28ab-c29c-fe067854abbd"
				classificationScheme="urn:uuid:cccf5598-8b07-4b77-a05e-ae952c785ead"
				classifiedObject="Doc01" nodeRepresentation="Hospital Setting">
				<Slot name="codingScheme">
					<ValueList>
						<Value>Connect-a-thon healthcareFacilityTypeCodes</Value>
					</ValueList>
				</Slot>
				<Name>
					<LocalizedString value="Hospital Setting"/>
				</Name>
			</Classification>
			   <!-- Required Type Code -->
			<Classification id="urn:uuid:81dfbd93-a50b-c603-c867-50640424eb1d"
				classificationScheme="urn:uuid:41a5887f-8865-4c09-adf7-e362475b143a"
				classifiedObject="Doc01" nodeRepresentation="CCD">
				<Slot name="codingScheme">
					<ValueList>
						<Value>Connect-a-thon classCodes</Value>
					</ValueList>
				</Slot>
				<Name>
					<LocalizedString value="Continuity of Care Document"/>
				</Name>
			</Classification>
			<!-- Required Healthcare Facility Type Code -->
             <rim:Classification id="cl-$doc1-5" classificationScheme="urn:uuid:f33fb8ac-18af-42cc-ae0e-ed0b0bdb91e1"
                                classifiedObject="$doc1" nodeRepresentation="[Outpatient Setting Code]">
                <rim:Slot name="codingScheme">
                    <rim:ValueList>
                        <rim:Value>2.16.840.1.113883.3.3251.3.2.1</rim:Value>
                    </rim:ValueList>
                </rim:Slot>
                <rim:Name>
                    <rim:LocalizedString value="Outpatient"/>
                </rim:Name>
            </rim:Classification>
            <!-- Required Practice Setting Code -->
			<Classification 
				id="urn:uuid:fb57bcf4-7f7a-28ab-c29c-fe067854abbd"
				classificationScheme="urn:uuid:cccf5598-8b07-4b77-a05e-ae952c785ead"
				classifiedObject="Doc01" nodeRepresentation="[Hospital Setting Code]">
				<Slot name="codingScheme">
					<ValueList>
					<Value>2.16.840.1.113883.3.3251.3.2.2</Value>
					</ValueList>
				</Slot>
				<Name>
					<LocalizedString value="Hospital Setting"/>
				</Name>
			</Classification>
			            <!-- Required Document/Artifact Type Code -->
			<Classification id="urn:uuid:81dfbd93-a50b-c603-c867-50640424eb1d"
				classificationScheme="urn:uuid:41a5887f-8865-4c09-adf7-e362475b143a"
				classifiedObject="Doc01" nodeRepresentation="34133-9">
				<Slot name="codingScheme">
					<ValueList>
					<Value>2.16.840.1.113883.3.3251.3.2.3</Value>
					</ValueList>
				</Slot>
				<Name>
				<LocalizedString value="Summarization of episode note"/>
				</Name>
			</Classification>
            
			
			 <!-- intendedRecipient comes from the To header.
                            It must be prepended with ||^^Internet^ -->
                        <rim:Slot name="intendedRecipient">
                            <rim:ValueList>
                                <rim:Value> ||^^ Internet^drsmith@direct.happyvalley.example.com
                                </rim:Value>
                            </rim:ValueList>
                        </rim:Slot>