IHE-XACML Binding

Aktuelle Version vom 16. März 2015, 16:41 Uhr

Dieses Material ist Teil des Leitfadens IHE Cookbook.

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 .

Binding of IHE XD* Metadata and IHE XUA Attributes to XACML 2.0

This binding describes a standard mechanism to express all potentially security relevant XDS, XDR and XDM metadata attributes in a XACML engine. It enables other integration profiles to use XACML mechanisms to enforce restrictions on access to documents and other information objects that are transmitted via XD* profile transactions.

Inhaltsverzeichnis

1 Custom Data Types (and related Comparison Functions) used for the bindings
- 1.1 Custom Data Types
- 1.2 Custom Comparison Functions
2 IHE XUA User Attributes Binding
3 IHE XDS Document Attribute Bindings
4 IHE Folder Attributes
5 Submission Set

Custom Data Types (and related Comparison Functions) used for the bindings

This section specifies the data types (and functions based on these data types) that are not included in the XACML 2.0 Core specification, but are necessary for a consistent binding between IHE XUA / IHE XDS and XACML.

Custom Data Types

urn:hl7-org:v3#CV

The data type is based on the HL7v3 "Coded Value" data type (see HL7v3 Abstract Data Type Specification - ANSI/HL7 V3 DT, R1-2004 11/29/2004; section 2.9). A CV must have the XML element "codedValue" with the XML attributes "code" and "codeSystem". "code" may be any string. "codeSystem" must be an OID, but this does not have to be validated or verified by the implementor. A CV may also have the XML attributes "codeSystemName", "codeSystemVersion", "displayName" and the XML child element "originalText", but these may be safely ignored by the implementor.

Example:

<CodedValue code="1" codeSystem="1.0.14265.1" />

urn:hl7-org:v3#II

The data type is based on the HL7v3 "Instance Identifier" data type (see HL7v3 Abstract Data Type Specification - ANSI/HL7 V3 DT, R1-2004 11/29/2004; section 2.17). A II must have the XML element "InstanceIdentifier" with the XML attribute "root" and may have the XML attribute "extension"."extension" may be any string. "root" must be an OID, but this does not have to be validated or verified by the implementor. A II may also have the XML attribute "assigningAuthorityName" and "displayable", but these may be safely ignored by the implementor.

Example:

<InstanceIdentifier extension="11231" root="2.16.840.1.113883.3.37.4.1.1.72364" />

Custom Comparison Functions

urn:hl7-org:v3:function:CV-equal

This function SHALL take two arguments of data-type "urn:hl7-org:v3#CV" and SHALL return an "http://www.w3.org/2001/XMLSchema#boolean". The function SHALL return "True" if and only if the "code" attribute of both of its arguments are equal according to the function "urn:oasis:names:tc:xacml:1.0:function:string-equal" AND the "codeSystem" attribute of both of its arguments are equal according to the function "urn:oasis:names:tc:xacml:1.0:function:string-equal". Otherwise, it SHALL return "False".

urn:hl7-org:v3:function:II-to-string

This function SHALL take one argument of data-type "urn:hl7-org:v3#II" and SHALL return an "http://www.w3.org/2001/XMLSchema#string". The function SHALL return the "root" attribute of its argument if and only if the "extension" attribute of its arguments is empty. Otherwise, it SHALL return the concatenation of the "root" attribute of its argument, the character "@", and the "extension" attribute of its argument (in this order) according to the function "urn:oasis:names:tc:xacml:2.0:function:string-concatenate".

urn:hl7-org:v3:function:II-equal

This function SHALL take two arguments of data-type "urn:hl7-org:v3#II" and SHALL return an "http://www.w3.org/2001/XMLSchema#boolean". The function SHALL return "True" a) if and only if the extension attribute is empty and the "root" attribute of both of its arguments are equal according to the function "urn:oasis:names:tc:xacml:1.0:function:string-equal" OR b) if and only if the "extension" attribute of both of its arguments are equal according to the function "urn:oasis:names:tc:xacml:1.0:function:string-equal" AND the "root" attribute of both of its arguments are equal according to the function "urn:oasis:names:tc:xacml:1.0:function:string-equal". Otherwise, it SHALL return "False".

urn:hl7-org:v3:function:II-match

This function SHALL take one argument of data-type "urn:hl7-org:v3#II" and one of data-type "http://www.w3.org/2001/XMLSchema#string". It SHALL return an "http://www.w3.org/2001/XMLSchema#boolean". The function SHALL convert the "urn:hl7-org:v3#II" to a "http://www.w3.org/2001/XMLSchema#string" according to the rules of "urn:hl7-org:v3:function:II-to-string". The function SHALL then return "True" if and only if the converted "urn:hl7-org:v3#II" argument is equal to the "http://www.w3.org/2001/XMLSchema#string" argument according to the rules of "urn:oasis:names:tc:xacml:1.0:function:string-equal". Otherwise, it SHALL return "False".

urn:ihe-d:cookbook:function:2015:SeR-URN-to-CV

This function SHALL take one argument of data-type "http://www.w3.org/2001/XMLSchema#anyURI" that adheres to the IHE Secure Retrieval Profile definition of a URN encoded coded value and SHALL return a "urn:hl7-org:v3#CV". The function SHALL seperate the first argument into tokens seperated by the colon (":") character. Each token must be URN-decoded to replace the percentage encoded characters by the actual characters. Each token MUST NOT include the colon character. The function SHALL then create a "urn:hl7-org:v3#CV" using the 6th token as the "codeSystem" element and the 8th token as the "code" element. The function MAY additionally use the 7th token as the "codeSystemName" element and the 9th token as the "displayName" element. The function SHALL then return the created "urn:hl7-org:v3#CV".

urn:ihe-d:cookbook:function:2015:CV-equal-to-SeR-URN

This function SHALL take one argument of data-type "urn:hl7-org:v3#CV" and one of data-type "http://www.w3.org/2001/XMLSchema#anyURI" that adheres to the IHE Secure Retrieval Profile definition of a URN encoded coded value. It SHALL return an "http://www.w3.org/2001/XMLSchema#boolean". The function SHALL convert the "http://www.w3.org/2001/XMLSchema#anyURI"´to a "urn:hl7-org:v3#CV" using the function "urn:ihe-d:cookbook:function:2015:anyURI-to-CV". The function SHALL then evaluate the first argument to the converted second argument according to the function "urn:hl7-org:v3:function:CV-equal". If the comparison yields a "True", the function SHALL return "True". Otherwise it shall return "False".

IHE XUA User Attributes Binding

User ID

IHE XUA Definition	3.40.4.1.2 as "Subject": "logical identifier of the principal performing the original service request"
SAML Attribute Name	n/a, not an attribute in SAML
SAML Example	<saml:Subject> <saml:NameID>user1</saml:NameID> <saml:SubjectConfirmation Method="urn:oasis:names:tc:SAML:2.0:cm:bearer"/> </saml:Subject>
XACML Target Section	subject
XACML Attribute ID	urn:oasis:names:tc:xacml:1.0:subject:subject-id
XACML Data Type	http://www.w3.org/2001/XMLSchema#string
XACML Attribute Value Content	No restrictions
XACML Example	<Attribute AttributeId="urn:oasis:names:tc:xacml:1.0:subject:subject-id" DataType="http://www.w3.org/2001/XMLSchema#string"> <AttributeValue>user1</AttributeValue> </Attribute>
Comment	The user’s id does not need an SAML attribute name, but it needs an attribute ID in XACML.

User’s Full Name

IHE XUA Definition	3.40.4.1.2 as "Subject ID": "plain text description of the user's name (not user ID)"
SAML Attribute Name	urn:oasis:names:tc:xspa:1.0:subject:subject-id
SAML Example	<saml:Attribute Name="urn:oasis:names:tc:xspa:1.0:subject:subject-id"> <saml:AttributeValue>Walter H.Brattain IV</saml:AttributeValue> </saml:Attribute>
XACML Target Section	subject
XACML Attribute ID	http://www.ietf.org/rfc/rfc2256.txt#cn
XACML Data Type	http://www.w3.org/2001/XMLSchema#string
XACML Attribute Value Content	Plain text, format SHOULD be "<firstName> <secondName> <middleName> <lastName>" unless realm-specific standards suggest otherwise
XACML Example	<Attribute AttributeId="http://www.ietf.org/rfc/rfc2256.txt#cn"> DataType="http://www.w3.org/2001/XMLSchema#string"> <AttributeValue>Walter H. Brattain IV</AttributeValue> </Attribute>
Comment	The user’s id does not need an SAML attribute name, but it needs an attribute ID in XACML. Therefore the plain text name is moved to the LDAP-based attribute ID, to avoid using two different URNs ending in subject-id. "Where a suitable attribute is already defined in LDAP, the XACML identifier SHALL be formed by adding the attribute name to the URI of the LDAP specification." (XACML 2.0 Core, Appendix B.5, line 5027f.)

User Organization

IHE XUA Definition	3.40.4.1.2 as "Subject Organization": "plain text description of the organization"
SAML Attribute Name	urn:oasis:names:tc:xspa:1.0:subject:organization
SAML Example	<saml:Attribute Name="urn:oasis:names:tc:xspa:1.0:subject:organization"> <saml:AttributeValue>Family Medical Clinic</saml:AttributeValue> </saml:Attribute>
XACML Target Section	subject
XACML Attribute ID	urn:oasis:names:tc:xspa:1.0:subject:organization
XACML Data Type	http://www.w3.org/2001/XMLSchema#string
XACML Attribute Value Content	No restrictions
XACML Example	<Attribute AttributeId="urn:oasis:names:tc:xspa:1.0:subject:organization" DataType="http://www.w3.org/2001/XMLSchema#string"> <AttributeValue>Family Medical Clinic</AttributeValue> </Attribute>
Comment

User Organization ID

IHE XUA Definition	3.40.4.1.2 as "Subject Organization ID": "a unique identifier for the organization that the user is representing in performing this transaction"
SAML Attribute Name	urn:oasis:names:tc:xspa:1.0:subject:organization-id
SAML Example	<saml:Attribute Name="urn:oasis:names:tc:xspa:1.0:subject:organization-id"> <saml:AttributeValue>http://familymedicalclinic.org</saml:AttributeValue> </saml:Attribute> </syntaxhighlight>
XACML Target Section	subject
XACML Attribute ID	urn:oasis:names:tc:xspa:1.0:subject:organization-id
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content	The organization ID MUST be one of: a) Object Identifier (OID), using the urn format (that is, "urn:oid:" appended with the OID); b) a URL assigned to that organization.
XACML Example	<Attribute AttributeId="urn:oasis:names:tc:xspa:1.0:subject:organization-id" DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue>http://familymedicalclinic.org</AttributeValue> </Attribute>
Comment

User Home Community ID

IHE XUA Definition	3.40.4.1.2 as "Home Community ID Attribute": "the Home Community ID (an Object Identifier) assigned to the Community that is initiating the request"
SAML Attribute Name	urn:ihe:iti:xca:2010:homeCommunityId
SAML Example	<saml:Attribute Name="urn:ihe:iti:xca:2010:homeCommunityId"> <saml:AttributeValue>urn:oid:2.16.840.1.113883.3.190</saml:AttributeValue> </saml:Attribute>
XACML Target Section	subject
XACML Attribute ID	urn:ihe:iti:xca:2010:homeCommunityId
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content	The identifier MUST be an Object Identifier (OID), using the urn format ("urn:oid:" appended with the OID)
XACML Example	<Attribute AttributeId="urn:ihe:iti:xca:2010:homeCommunityId" DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue>urn:oid:2.16.840.1.113883.3.190</AttributeValue> </Attribute>
Comment

National Provider Identifier (NPI)

IHE XUA Definition	3.40.4.1.2 as "National Provider Identifier (NPI) Attribute": "A National Provider Identifier (NPI) is a unique identifier issued to health care providers by their national authority"
SAML Attribute Name	urn:oasis:names:tc:xspa:2.0:subject:npi
SAML Example	<saml:Attribute Name="urn:oasis:names:tc:xspa:2.0:subject:npi"> <saml:AttributeValue>1234567890</saml:AttributeValue> </saml:Attribute>
XACML Target Section	subject
XACML Attribute ID	urn:oasis:names:tc:xspa:2.0:subject:npi
XACML Data Type	urn:hl7-org:v3#II
XACML Attribute Value Content	When the simplified form without the assigning authority is used, the transforming actor must add the required instance identifier root.
XACML Example	<Attribute AttributeId="urn:oasis:names:tc:xspa:2.0:subject:npi" DataType="urn:hl7-org:v3#II"> <AttributeValue> <hl7:InstanceIdentifier extension="1234567890" root="2.16.840.1.113883.4.6" /> </AttributeValue> </Attribute>
Comment

User Role

IHE XUA Definition	3.40.4.1.2.1 as "Subject-Role": "the relevant user subject roles from a locally defined Code-Set"
SAML Attribute Name	urn:oasis:names:tc:xacml:2.0:subject:role
SAML Example	<saml:Attribute Name="urn:oasis:names:tc:xacml:2.0:subject:role"> <saml:AttributeValue> <Role xmlns="urn:hl7-org:v3" xsi:type="CE" code="46255001" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED_CT" displayName="Pharmacist"/> </saml:AttributeValue> </saml:Attribute>
XACML Target Section	Subject
XACML Attribute ID	urn:oasis:names:tc:xacml:2.0:subject:role
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content
XACML Example	<Attribute AttributeId="urn:oasis:names:tc:xacml:2.0:subject:role" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="46255001" codeSystem="2.16.840.1.113883.6.96" /> </AttributeValue> </Attribute>
Comment	Using changing element names for coded values with the typification coming from the xsi:type attributes has its disadvantage when writing complex XACML policies (esp. regarding schema support). Therefore the resulting XACML constructs use a fixed element name with the semantic context provided by the attribute ID.

Purpose Of Use

IHE XUA Definition	3.40.4.1.2.3 as "PurposeOfUse": "the coded representation of the Purpose for Use that is in effect for the request"
SAML Attribute Name	urn:oasis:names:tc:xspa:1.0:subject:purposeofuse
SAML Example	<saml:Attribute name="urn:oasis:names:tc:xspa:1.0:subject:purposeofuse"> <saml:AttributeValue> <PurposeOfUse xmlns="urn:hl7-org:v3" xsi:type="CE" code="12" codeSystem="1.0.14265.1" codeSystemName="ISO 14265 Classification of Purposes for processing personal health information" displayName="Law Enforcement"/> </saml:AttributeValue> </saml:Attribute>
XACML Target Section	subject
XACML Attribute ID	urn:oasis:names:tc:xspa:1.0:subject:purposeofuse
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content
XACML Example	<Attribute AttributeId="urn:oasis:names:tc:xspa:1.0:subject:purposeofuse" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="1" codeSystem="1.0.14265.1" /> </AttributeValue> </Attribute>
Comment	TODO: Clarify the need for the .1 at the end of the ISO OID

IHE XDS Document Attribute Bindings

Author Institution (Name)

IHE XDS Definition	4.2.3.1.4.1 as "authorInstitution": "Represents a specific healthcare facility under which the human and/or machines authored the document or SubmissionSet. This is a sub-attribute of the author attribute."
ebXML Name	classificationScheme="urn:uuid:93606bcf-9494-43ec-9b4e-a7748d1a838d"; Slot name="authorInstitution"
ebXML Example	<rim:Slot name="authorInstitution"> <rim:ValueList> <rim:Value>MercyHospital</rim:Value> <rim:Value>NY Mercy Hospital^^^^^^^^^1.2.3.9.1789.45</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:author-institution:name
XACML Data Type	http://www.w3.org/2001/XMLSchema#string
XACML Attribute Value Content	Use XON.1 of the authorInstitution
Attribute ID also used in	SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:author-institution:name" DataType="http://www.w3.org/2001/XMLSchema#string"> <AttributeValue>NY Mercy Hospital</AttributeValue> </Attribute>
Comment

Author Institution (ID)

IHE XDS Definition	4.2.3.1.4.1 as "authorInstitution": "Represents a specific healthcare facility under which the human and/or machines authored the document or SubmissionSet. This is a sub-attribute of the author attribute."
ebXML Name	classificationScheme="urn:uuid:93606bcf-9494-43ec-9b4e-a7748d1a838d"; Slot name="authorInstitution"
ebXML Example	<rim:Slot name="authorInstitution"> <rim:ValueList> <rim:Value>MercyHospital</rim:Value> <rim:Value>NY Mercy Hospital^^^^^^^^^1.2.3.9.1789.45</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:author-institution:id
XACML Data Type	urn:hl7-org:v3#II
XACML Attribute Value Content	Use XON.6.2 as root and XON.10 as extension or (if XON.10 is an OID) use XON.10 as root
Attribute ID also used in	SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:author-institution:id" DataType="urn:hl7-org:v3#II"> <AttributeValue> <hl7:InstanceIdentifier root="1.2.3.9.1789.45"/> </AttributeValue> </Attribute>
Comment

Author Person (Name)

IHE XDS Definition	4.2.3.1.4.2 as "authorPerson": "Represents the humans and/or machines that authored the document or SubmissionSet within the authorInstitution. The author may be the patient itself. This is a sub-attribute of the author attribute."
ebXML Name	classificationScheme="urn:uuid:93606bcf-9494-43ec-9b4e-a7748d1a838d"; Slot name="authorPerson"
ebXML Example	<rim:Slot name="authorPerson"> <rim:ValueList> <rim:Value>11375^Welby^Marcus^J^Jr. MD^Dr^^^&1.2.840.113619.6.197&ISO</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:author-person:name
XACML Data Type	http://www.w3.org/2001/XMLSchema#string
XACML Attribute Value Content	Should use the format <prefix> <first name> <second and further given names> <last name> <suffix>
Attribute ID also used in	SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:author-person:name" DataType="http://www.w3.org/2001/XMLSchema#string"> <AttributeValue>Dr Marcus J Welby Jr. MD</AttributeValue> </Attribute>
Comment

Author Person (ID)

IHE XDS Definition	4.2.3.1.4.2 as "authorPerson": "Represents the humans and/or machines that authored the document or SubmissionSet within the authorInstitution. The author may be the patient itself. This is a sub-attribute of the author attribute."
ebXML Name	classificationScheme="urn:uuid:93606bcf-9494-43ec-9b4e-a7748d1a838d"; Slot name="authorPerson"
ebXML Example	<rim:Slot name="authorPerson"> <rim:ValueList> <rim:Value>11375^Welby^Marcus^J^Jr. MD^Dr^^^&1.2.840.113619.6.197&ISO</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:author-person:id
XACML Data Type	urn:hl7-org:v3#II
XACML Attribute Value Content	Use XCN.9 as root and XCN.1 as extension or (if XCN.1 is an OID) use XCN.1 as root
Attribute ID also used in	SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:author-person:id" DataType="urn:hl7-org:v3#II"> <AttributeValue> <hl7:InstanceIdentifier extension="11375" root="1.2.840.113619.6.197"/> </AttributeValue> </Attribute>
Comment

Author Role

IHE XDS Definition	4.2.3.1.4.3 as "authorRole": "A string that represents the role of the author with respect to the patient at the time the document or SubmissionSet was created. This is a sub-attribute of the author attribute."
ebXML Name	classificationScheme="urn:uuid:93606bcf-9494-43ec-9b4e-a7748d1a838d"; Slot name="authorRole"
ebXML Example	<rim:Slot name="authorRole"> <rim:ValueList> <rim:Value>PCP^^^&2.16.840.1.113883.19.9&ISO</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:author-role
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content	Use CX.4.2 as codeSystem and CX.1 as extension; if it is not coded as a CX data type, a default codeSystem must be defined for the affinity domain
Attribute ID also used in	SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:author-role" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="PCP" codeSystem="2.16.840.1.113883.19.9"/> </AttributeValue> </Attribute>
Comment

Author Speciality

IHE XDS Definition	4.2.3.1.4.4 as "authorSpeciality": "Represents a specific specialty within a healthcare facility under which the human and/or machines authored the document or SubmissionSet. This is a sub-attribute of the author attribute."
ebXML Name	classificationScheme="urn:uuid:93606bcf-9494-43ec-9b4e-a7748d1a838d"; Slot name="authorSpeciality"
ebXML Example	<rim:Slot name="authorSpeciality"> <rim:ValueList> <rim:Value>Cardiology^^^&2.16.840.1.113883.19.10&ISO</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:author-speciality
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content	Use CX.4.2 as codeSystem and CX.1 as extension; if it is not coded as a CX data type, a default codeSystem must be defined for the affinity domain
Attribute ID also used in	SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:author-speciality" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="Cardiology" codeSystem="2.16.840.1.113883.19.10"/> </AttributeValue> </Attribute>
Comment

Availability Status

IHE XDS Definition	4.2.3.2.2 as "DocumentEntry.availabilityStatus": "Represents the status of the DocumentEntry. A DocumentEntry shall have one of two availability statuses: Approved: The document is available for patient care. Deprecated: The document is obsolete."
ebXML Name	"status" attribute of "ExtrinsicObject" element
ebXML Example	<ExtrinsicObject id="urn:uuid:fbeacdb7-5421-4474-9267-985007cd8855" objectType="urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1" status="urn:oasis:names:tc:ebxml-regrep:StatusType:Approved"> ...
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:availability-status
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content	"urn:oasis:names:tc:ebxml-regrep:StatusType:Approved" or "urn:oasis:names:tc:ebxml-regrep:StatusType:Deprecated" or any other valid availabilityStatus defined by an extension or by a new profile
Attribute ID also used in	Folder, SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:availability-status" DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue>urn:oasis:names:tc:ebxml-regrep:StatusType:Approved</AttributeValue> </Attribute>
Comment

Class Code

IHE XDS Definition	4.2.3.2.3 as "DocumentEntry.classCode": "The code specifying the particular kind of document (e.g., Prescription, Discharge Summary, Report). Valid values for this metadata attribute are specified 1250 by the policies of the creating entity. It is recommended that the creating entity draws these values from a coding scheme providing a coarse level of granularity (about 10 to 100 entries). For example, XDS specifies that the XDS Affinity Domain will establish this list."
ebXML Name	classificationScheme="urn:uuid:41a5887f-8865-4c09-adf7-e362475b143a"
ebXML Example	<rim:Classification classificationScheme="urn:uuid:41a5887f-8865-4c09-adf7-e362475b143a" classifiedObject="ExampleDocument" id="IdExample_046" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification" nodeRepresentation="10160-0" > <rim:Name> <rim:LocalizedString value="History of Medication Use"/> </rim:Name> <rim:Slot name="codingScheme"> <rim:ValueList> <rim:Value>2.16.840.1.113883.6.1</rim:Value> </rim:ValueList> </rim:Slot> </rim:Classification>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:document-entry:class-code
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:document-entry:class-code" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="10160-0" codeSystem="2.16.840.1.113883.6.1"/> </AttributeValue> </Attribute>
Comment

Confidentiality Code

IHE XDS Definition	4.2.3.2.5 as "DocumentEntry.confidentialityCode": "The code specifying the level of confidentiality of the document. These codes are set by policy of the creating entity and issues related to highly sensitive documents are beyond the scope of metadata definition. These issues are expected to be addressed separately. confidentialityCode is part of a codification scheme."
ebXML Name	classificationScheme="urn:uuid:f4f85eac-e6cb-4883-b524-f2705394840f"
ebXML Example	<rim:Classification classificationScheme="urn:uuid:f4f85eac-e6cb-4883-b524-f2705394840f" classifiedObject="ExampleDocument" id="IdExample_046" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification" nodeRepresentation="N"> <rim:Name> <rim:LocalizedString value="Normal"/> </rim:Name> <rim:Slot name="codingScheme"> <rim:ValueList> <rim:Value>2.16.840.1.113883.5.25</rim:Value> </rim:ValueList> </rim:Slot> </rim:Classification>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:confidentiality-code
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:confidentiality-code" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="N" codeSystem="2.16.840.1.113883.5.25"/> </AttributeValue> </Attribute>
Comment

Creation Time

IHE XDS Definition	4.2.3.2.6 as "DocumentEntry.creationTime": "Represents the time the author created the document."
ebXML Name	Slot name = "creationTime"
ebXML Example	<rim:Slot name="creationTime"> <rim:ValueList> <rim:Value>20041225212010</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:document-entry:creation-time
XACML Data Type	http://www.w3.org/2001/XMLSchema#dateTime
XACML Attribute Value Content	This point in time must be transformed into a valid instance of an XML dateTime (which is based of ISO8601). This may involve adding date or time components, because in XDS the DTM data type allows for partial dates. To transform incomplete creationDates into dateTime instances the implementor MUST use the smallest instant covered by the partial date. E.g. "200904" would be transformed to "2009-04-01T00:00:00Z". The XACML dateTime must be expressed as UTC using 'Z' as the timezone indicator. The XDS DTM data type also allows only for UTC as the timezone, therefore no transformation is necessary.
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:document-entry:creation-time" DataType="http://www.w3.org/2001/XMLSchema#dateTime"> <AttributeValue>2004-12-25T21:20:10Z</AttributeValue> </Attribute>
Comment

Event Code

IHE XDS Definition	4.2.3.2.8 as "DocumentEntry.eventCodeList": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. An event can further specialize the act inherent in the typeCode, such as where it is 1365 simply "Procedure Report" and the procedure was a "colonoscopy". When defining the value sets for eventCodes, they should not conflict with the values inherent in the classCode, practiceSettingCode or typeCode as such a conflict would create an ambiguous situation."
ebXML Name	classificationScheme="urn:uuid:2c6b8cb7-8b2a-4051-b291-b1ae6a575ef4"
ebXML Example	<rim:Classification classificationScheme="urn:uuid:2c6b8cb7-8b2a-4051-b291-b1ae6a575ef4" classifiedObject="ExampleDocument" id="IdExample_048" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification" nodeRepresentation="45.23"> <rim:Name> <rim:LocalizedString value="Colonoscopy"/> </rim:Name> <rim:Slot name="codingScheme"> <rim:ValueList> <rim:Value>ICD-9-CM</rim:Value> </rim:ValueList> </rim:Slot> </rim:Classification>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:document-entry:event-code
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:document-entry:event-code" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="45.23" codeSystem="2.16.840.1.113883.6.2"/> </AttributeValue> </Attribute>
Comment

Healthcare Facility Type Code

IHE XDS Definition	4.2.3.2.11 as "DocumentEntry .healthcareFacilityTypeCode": "This code represents the type of organizational setting of the clinical encounter during which the documented act occurred. In some cases, the setting of the encounter is inherent in the typeCode, such as "Diabetes Clinic Progress Note". healthcareFacilityTypeCode shall be equivalent to or further specialize the value inherent in the typeCode; for example, where the typeCode is simply "Clinic Progress Note" and the value of healthcareFacilityTypeCode is "private clinic"."
ebXML Name	classificationScheme="urn:uuid:f33fb8ac-18af-42cc-ae0e-ed0b0bdb91e1"
ebXML Example	<rim:Classification classificationScheme="urn:uuid:f33fb8ac-18af-42cc-ae0e-ed0b0bdb91e1" classifiedObject="ExampleDocument" id="IdExample_050" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification" nodeRepresentation="310400000X"> <rim:Name> <rim:value="Assisted Living Facility"/> </rim:Name> <rim:Slot name="codingScheme"> <rim:ValueList> <rim:Value>NUCC Health Care Provider Taxonomy</rim:Value> </rim:ValueList> </rim:Slot> </rim:Classification>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:document-entry:healthcare-facility-type-code
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:document-entry:healthcare-facility-type-code" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="310400000X " codeSystem="2.16.840.1.113883.6.101"/> </AttributeValue> </Attribute>
Comment

Home Community ID

IHE XDS Definition	4.2.3.2.12 as "DocumentEntry .homeCommunityId": "A globally unique identifier for a community where the DocumentEntry and document can be accessed."
ebXML Name	"home" attribute of ExtrinsicObject element
ebXML Example	<rim:ExtrinsicObject home="urn:oid:2.16.840.1.113883.19.14" ...> ... </rim:ExtrinsicObject>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:home-community-id
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content	The identifier MUST be an Object Identifier (OID), using the urn format ("urn:oid:" appended with the OID)
Attribute ID also used in	Folder, SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:home-community-id" DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue>urn:oid:2.16.840.1.113883.19.14</AttributeValue> </Attribute>
Comment

Legal Authenticator

IHE XDS Definition	4.2.3.1.4.14 as "legalAuthenticator": "Represents a participant within the authorInstitution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legalAuthenticator."
ebXML Name	Slot name="legalAuthenticator"
ebXML Example	<rim:Slot name="legalAuthenticator"> <rim:ValueList> <rim:Value>11375^Welby^Marcus^J^Jr. MD^Dr^^^&1.2.840.113619.6.197&ISO</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:document-entry:legal-authenticator:id
XACML Data Type	urn:hl7-org:v3#II
XACML Attribute Value Content	Use XCN.9 as root and XCN.1 as extension or (if XCN.1 is an OID) use XCN.1 as root
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:document-entry:legal-authenticator:id" DataType="urn:hl7-org:v3#II"> <AttributeValue> <hl7:InstanceIdentifier extension="11375" root="1.2.840.113619.6.197"/> </AttributeValue> </Attribute>
Comment

Patient ID

IHE XDS Definition	4.2.3.1.4.16 as "DocumentEntry.patientId": "The patientId represents the subject of care of the document. For XDS the patient identifier domain is the XDS Affinity Domain Patient Identifier Domain (XAD-PID). Within a submission request, the value of patientId of the DocumentEntries shall match that of the SubmissionSet."
ebXML Name	ExternalIdentifier with identificationScheme= "urn:uuid:58a6f841-87b3-4a3e-92fd-a8ffeff98427"
ebXML Example	<rim:ExternalIdentifier identificationScheme="urn:uuid:58a6f841-87b3-4a3e-92fd-a8ffeff98427" value="6578946^^^&1.3.6.1.4.1.21367.2005.3.7&ISO" id="IdExample_051" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier" registryObject="DocumentEntry01"> <rim:Name> <rim:LocalizedString value="XDSDocumentEntry.patientId "/> </rim:Name> </rim:ExternalIdentifier>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:patient-id
XACML Data Type	urn:hl7-org:v3#II
XACML Attribute Value Content	Use CX.4 as root and CX.1 as extension
Attribute ID also used in	Folder, SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:patient-id" DataType="urn:hl7-org:v3#II"> <AttributeValue> <hl7:InstanceIdentifier extension="6578946" root="1.3.6.1.4.1.21367.2005.3.7"/> </AttributeValue> </Attribute>
Comment

Practice Setting Code

IHE XDS Definition	4.2.3.2.17 as "DocumentEntry.practiceSettingCode": "The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology). It is suggested that the creating entity draws these values from a coding scheme providing a coarse level of granularity (about 10 to 100 entries)."
ebXML Name	classificationScheme="urn:uuid:cccf5598-8b07-4b77-a05e-ae952c785ead"
ebXML Example	<rim:Classification ClassificationScheme="urn:uuid:cccf5598-8b07-4b77-a05e-ae952c785ead" classifiedObject="ExampleDocument" id="IdExample_052" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification" nodeRepresentation="213ER0200X"> <rim:Name> <rim:LocalizedString value="Radiology"/> </rim:Name> <rim:Slot name="codingScheme"> <rim:ValueList> <rim:Value>NUCC Health Care Provider Taxonomy</rim:Value> </rim:ValueList> </rim:Slot> </rim:Classification>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:document-entry:practice-setting-code
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:document-entry:practice-setting-code" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="213ER0200X " codeSystem="2.16.840.1.113883.6.101"/> </AttributeValue> </Attribute>
Comment

Repository Unique ID

IHE XDS Definition	4.2.3.1.4.18 as "DocumentEntry.repositoryUniqueId": "The patientId represents the subject of care of the document. For XDS the patient identifier domain is the XDS Affinity Domain Patient Identifier Domain (XAD-PID). Within a submission request, the value of patientId of the DocumentEntries shall match that of the SubmissionSet."
ebXML Name	Slot name = "repositoryUniqueId"
ebXML Example	<rim:Slot name="repositoryUniqueId"> <rim:ValueList> <rim:Value>1.3.6.1.4.5</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:document-entry:repository-unique-id
XACML Data Type	urn:hl7-org:v3#II
XACML Attribute Value Content	Use the repository unique ID (which has to be an OID) as the root of the Instance Identifier.
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:document-entry:repository-unique-id" DataType="urn:hl7-org:v3#II"> <AttributeValue> <hl7:InstanceIdentifier root="1.3.6.1.4.5"/> </AttributeValue> </Attribute>
Comment

Service Start Time

IHE XDS Definition	4.2.3.2.19 as "DocumentEntry.serviceStartTime": "Represents the start time of the service being documented took place (clinically significant, but not necessarily when the document was produced or approved). This may be the same as the encounter time in case the service was delivered during an encounter. Encounter time is not coded in metadata but may be coded within the document."
ebXML Name	Slot name = "serviceStartTime"
ebXML Example	<rim:Slot name="serviceStartTime"> <rim:ValueList> <rim:Value>20041225212010</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:document-entry:service-start-time
XACML Data Type	http://www.w3.org/2001/XMLSchema#dateTime
XACML Attribute Value Content	This point in time must be transformed into a valid instance of an XML dateTime (which is based of ISO8601). This may involve adding date or time components, because in XDS the DTM data type allows for partial dates. To transform incomplete serviceStartTimes into dateTime instances the implementor MUST use the smallest instant covered by the partial date. E.g. "200904" would be transformed to "2009-04-01T00:00:00Z". The XACML dateTime must be expressed as UTC using 'Z' as the timezone indicator. The XDS DTM data type also allows only for UTC as the timezone, therefore no transformation is necessary.
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:document-entry:service-start-time" DataType="http://www.w3.org/2001/XMLSchema#dateTime"> <AttributeValue>2004-12-25T21:20:10Z</AttributeValue> </Attribute>
Comment

Service Stop Time

IHE XDS Definition	4.2.3.2.20 as "DocumentEntry.serviceStopTime": "Represents the stop time of the service being documented took place (clinically significant, but not necessarily when the document was produced or approved). This may be the same as the encounter time in case the service was delivered during an encounter. Encounter time is not coded in metadata but may be coded within the document. If the service happens at a point in time, this attribute shall contain the same value as the serviceStartTime."
ebXML Name	Slot name = "serviceStopTime"
ebXML Example	<rim:Slot name="serviceStopTime"> <rim:ValueList> <rim:Value>20041225212010</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:document-entry:service-stop-time
XACML Data Type	http://www.w3.org/2001/XMLSchema#dateTime
XACML Attribute Value Content	This point in time must be transformed into a valid instance of an XML dateTime (which is based of ISO8601). This may involve adding date or time components, because in XDS the DTM data type allows for partial dates. To transform incomplete serviceStopTimes into dateTime instances the implementor MUST use the biggest instant covered by the partial date (ignoring fractions of seconds). E.g. "200904" would be transformed to "2009-04-30T23:59:59Z". Implementors must handle leap years, but may ignore leap seconds. The XACML dateTime must be expressed as UTC using ‚Z‘ as the timezone indicator. The XDS DTM data type also allows only for UTC as the timezone, therefore no transformation is necessary.
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:document-entry:service-stop-time" DataType="http://www.w3.org/2001/XMLSchema#dateTime"> <AttributeValue>2004-12-25T21:20:10Z</AttributeValue> </Attribute>
Comment	The special case of leap years may be a relevant implementation hurdle when dealing with the partial date "xxxx02".

Source Patient ID

IHE XDS Definition	4.2.3.1.4.22 as "DocumentEntry.sourcePatientId": "The sourcePatientId represents the subject of care’s medical record Identifier (e.g., Patient Id) in the local patient identifier domain of the creating entity at the time the document entry was submitted."
ebXML Name	Slot name= "sourcePatientId"
ebXML Example	<rim:Slot name="sourcePatientId"> <rim:ValueList> <rim:Value>j98789^^^&1.2.3.4.343.1&ISO</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:document-entry:source-patient-id
XACML Data Type	urn:hl7-org:v3#II
XACML Attribute Value Content	Use CX.4 as root and CX.1 as extension
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:document-entry:source-patient-id" DataType="urn:hl7-org:v3#II"> <AttributeValue> <hl7:InstanceIdentifier extension="j98789" root="1.2.3.4.343.1"/> </AttributeValue> </Attribute>
Comment

Type Code

IHE XDS Definition	4.2.3.2.25 as "DocumentEntry.typeCode": "The code specifying the precise kind of document (e.g., Pulmonary History and Physical, Discharge Summary, Ultrasound Report). It is recommended that the creating entity draw these values from a coding scheme providing a fine level of granularity."
ebXML Name	classificationScheme="urn:uuid:f0306f51-975f-434e-a61c-c59651d33983"
ebXML Example	<rim:Classification classificationScheme="urn:uuid:f0306f51-975f-434e-a61c-c59651d33983" classifiedObject="ExampleDocument" nodeRepresentation="57016-8" id="IdExample_053" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification"> <rim:Name> <rim:LocalizedString value="Privacy Policy Acknowledgement Document" /> </rim:Name> <rim:Slot name="codingScheme"> <rim:ValueList> <rim:Value>2.16.840.1.113883.6.1</rim:Value> </rim:ValueList> </rim:Slot> </rim:Classification>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:document-entry:type-code
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:document-entry:type-code " DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="57016-8" codeSystem="2.16.840.1.113883.6.1"/> </AttributeValue> </Attribute>
Comment

Document Unique ID

IHE XDS Definition	4.2.3.2.26 as "DocumentEntry.uniqueId": "Globally unique identifier assigned to the document by the creating entity. A DocumentEntry representing a single document is identified by the uniqueId attribute; the linkage between DocumentEntry and the document it represents is made with the uniqueId attribute. This unique identifier may be used in other documents to reference this document."
ebXML Name	ExternalIdentifier with identificationScheme="urn:uuid:2e82c1f6-a085-4c72-9da3-8640a32e42ab"
ebXML Example	<rim:ExternalIdentifier identificationScheme="urn:uuid:2e82c1f6-a085-4c72-9da3-8640a32e42ab" value="1.2.3.4.5.6.78901.2345.6.7^123456" id="IdExample_054" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier" registryObject="DocumentEntry01"> <rim:Name> <rim:LocalizedString value="XDSDocumentEntry.uniqueId"/> </rim:Name> </rim:ExternalIdentifier>
XACML Target Section	Resource
XACML Attribute ID	urn:oasis:names:tc:xacml:1.0:resource:resource-id
XACML Data Type	http://www.w3.org/2001/XMLSchema#string
XACML Attribute Value Content
Attribute ID also used in	Folder, SubmissionSet
XACML Example	<Attribute AttributeId="urn:oasis:names:tc:xacml:1.0:resource:resource-id" DataType="http://www.w3.org/2001/XMLSchema#string"> <AttributeValue>1.2.3.4.5.6.78901.2345.6.7^123456</AttributeValue> </Attribute>
Comment

Related Folder Unique ID

IHE XDS Definition	4.2.3.4.9 as "Folder.uniqueId": "Globally unique identifier for the folder instance assigned by the creating entity."
ebXML Name	ExternalIdentifier with identificationScheme="urn:uuid:75df8f67-9973-4fbe-a900-df66cefecc5a"
ebXML Example	<rim:ExternalIdentifier identificationScheme="urn:uuid:75df8f67-9973-4fbe-a900-df66cefecc5a" id="IdExample_059" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier" value="1.3.6.1.4.1.21367.2005.3.7.3670984664" registryObject="Folder01"> <rim:Name> <rim:LocalizedString value="XDSFolder.uniqueId"/> </rim:Name> </rim:ExternalIdentifier>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:document-entry:related-folder:id
XACML Data Type	http://www.w3.org/2001/XMLSchema#string
XACML Attribute Value Content	The implementor MUST include the uniqueIDs of all folders currently associated with the document entry, i.e. folders that are associated via the hasMember association and where the folder availabilityStatus is "Approved". Please note that they are entered into the context as attributes of the document entry.
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:document-entry:related-folder:id" DataType="http://www.w3.org/2001/XMLSchema#string"> <AttributeValue> 1.3.6.1.4.1.21367.2005.3.7.3670984664</AttributeValue> </Attribute>
Comment	Interpreting the related folders as attributes of the documentEntry, allows for using folders to control access to documents, e.g. granting access to all documents associated with a specific folder.

Related Folder Code

IHE XDS Definition	4.2.3.4.2 as "Folder.codeList": "Shall contain the set of codes specifying the type of clinical activity that resulted in placing Documents in this Folder. These values shall be drawn from a vocabulary or coding scheme defined by the creating entity."
ebXML Name	ExternalIdentifier with identificationScheme="urn:uuid:75df8f67-9973-4fbe-a900-df66cefecc5a"
ebXML Example	<rim:Classification classificationScheme="urn:uuid:1ba97051-7806-41a8-a48b-8fce7af683c5" classifiedObject="ExampleFolder" id="IdExample_062" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification" nodeRepresentation="EMER"> <rim:Name> <rim:LocalizedString value="Emergency" /> </rim:Name> <rim:Slot name="codingScheme"> <rim:ValueList> <rim:Value>2.16.840.1.113883.1.11.13955</rim:Value> </rim:ValueList> </rim:Slot> </rim:Classification>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:document-entry:related-folder:code
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content	The implementor MUST include all codes of all folders currently associated with the document entry, i.e. folders that are associated via the hasMember association and where the folder availabilityStatus is "Approved". Please note that they are entered into the context as attributes of the document entry.
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:document-entry:related-folder:code" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="EMER" codeSystem="2.16.840.1.113883.1.11.13955"/> </AttributeValue> </Attribute>
Comment	Interpreting the related folders as attributes of the documentEntry, allows for using folders to control access to documents, e.g. granting access to all documents associated with a "emergency data" folder.

Source System ID

IHE XDS Definition	4.2.3.3.9 as "SubmissionSet.sourceId": "The globally unique, immutable, identifier of the entity that contributed the SubmissionSet. When a "broker" is involved in sending SubmissionSets from a collection of client systems, it shall use a different sourceId for submissions from each separate system to allow for tracking."
ebXML Name	ExternalIdentifier with identificationScheme="urn:uuid:554ac39e-e3fe-47fe-b233-965d2a147832"
ebXML Example	<rim:ExternalIdentifier identificationScheme="urn:uuid:554ac39e-e3fe-47fe-b233-965d2a147832" value="1.3.6.1.4.1.21367.2005.3.7" id="IdExample_058" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier" registryObject="SubmissionSet01"> <rim:Name> <rim:LocalizedString value="XDSSubmissionSet.sourceId"/> </rim:Name> </rim:ExternalIdentifier>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007: source-system-id
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content	The implementor MUST include the sourceId of the SubmissionSet in which the document entry was originally submitted. Please note that it is entered into the context as an attribute of the document entry.
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:source-system-id" DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue>1.3.6.1.4.1.21367.2005.3.7</AttributeValue> </Attribute>
Comment	Interpreting the submission source system as attributes of the documentEntry, allows for controlling access to documents based on "ownership", i.e. who uploaded the document. A typical example is extended visibility for documents uploaded by the user’s organization.

Resource Type

IHE XDS Definition	4.2.3.2 as DocumentEntry
ebXML Name	ExtrinsicObject with id="urn:uuid:fbeacdb7-5421-4474-9267-985007cd8855"
ebXML Example	<ExtrinsicObject id="urn:uuid:fbeacdb7-5421-4474-9267-985007cd8855" objectType="urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1" status="urn:oasis:names:tc:ebxml-regrep:StatusType:Approved"> ... </ExtrinsicObject>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe-d:cookbook:2013:resource-type
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content	for document entries fixed to "urn:ihe:iti:xds-b:2007:document-entry"
Attribute ID also used in	Folder, SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe-d:cookbook:2013:resource-type" DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue>urn:ihe:iti:xds-b:2007:document-entry</AttributeValue> </Attribute>
Comment	The resource type attribute allows using the same AttributeID for attributes used multiple types (e.g. Author Person ID is used in SubmissionSet and in DocumentEntry). This allows for policy writers to create policies that are applicable to multiple types of resources (e.g. SubmissionSets and DocumentEntries) while retaining the ability to distinguish between them when necessary.

IHE Folder Attributes

Availability Status

IHE XDS Definition	4.2.3.4.1 as "Folder.availabilityStatus": "Represents the status of the Folder. Since the deprecation of Folders is not allowed, this value shall always be Approved."
ebXML Name	"status" attribute of "RegistryPackage" element
ebXML Example	<rim:RegistryPackage id="urn:uuid:fbeacdb7-5421-4474-9267-985007cd8855" status="urn:oasis:names:tc:ebxml-regrep:StatusType:Approved">
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:availability-status
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content	"urn:oasis:names:tc:ebxml-regrep:StatusType:Approved" or "urn:oasis:names:tc:ebxml-regrep:StatusType:Deprecated" or any other valid availabilityStatus defined by an extension or by a new profile
Attribute ID also used in	DocumentEntry, SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:availability-status" DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue>urn:oasis:names:tc:ebxml-regrep:StatusType:Approved</AttributeValue> </Attribute>
Comment

Code

IHE XDS Definition	4.2.3.4.2 as "Folder.codeList": "Shall contain the set of codes specifying the type of clinical activity that resulted in placing Documents in this Folder. These values shall be drawn from a vocabulary or coding scheme defined by the creating entity."
ebXML Name	ExternalIdentifier with identificationScheme="urn:uuid:75df8f67-9973-4fbe-a900-df66cefecc5a"
ebXML Example	<rim:Classification classificationScheme="urn:uuid:1ba97051-7806-41a8-a48b-8fce7af683c5" classifiedObject="ExampleFolder" id="IdExample_062" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification" nodeRepresentation="EMER"> <rim:Name> <rim:LocalizedString value="Emergency" /> </rim:Name> <rim:Slot name="codingScheme"> <rim:ValueList> <rim:Value>2.16.840.1.113883.1.11.13955</rim:Value> </rim:ValueList> </rim:Slot> </rim:Classification>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:folder:code
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:folder:code" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="EMER" codeSystem="2.16.840.1.113883.1.11.13955"/> </AttributeValue> </Attribute>
Comment

Home Community ID

IHE XDS Definition	4.2.3.4.5 as "Folder.homeCommunityId": "A globally unique identifier for a community."
ebXML Name	"home" attribute of RegistryPackage element
ebXML Example	<rim:RegistryPackage home="urn:oid:2.16.840.1.113883.19.14" ...> ... </rim:RegistryPackage >
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:home-community-id
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content	The identifier MUST be an Object Identifier (OID), using the urn format ("urn:oid:" appended with the OID)
Attribute ID also used in	DocumentEntry, SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:home-community-id" DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue>urn:oid:2.16.840.1.113883.19.14</AttributeValue> </Attribute>
Comment

Last Update Time

IHE XDS Definition	4.2.3.4.6 as "Folder.lastUpdateTime": "Most recent point in time when a DocumentEntry was placed in the Folder."
ebXML Name	Slot name = "lastUpdateTime"
ebXML Example	<rim:Slot name="lastUpdateTime"> <rim:ValueList> <rim:Value>20041225212010</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:folder:last-update-time
XACML Data Type	http://www.w3.org/2001/XMLSchema#dateTime
XACML Attribute Value Content	This point in time must be transformed into a valid instance of an XML dateTime (which is based of ISO8601). This does not involve adding date or time components, because the last update time is set automatically by the registry. The XACML dateTime must be expressed as UTC using 'Z' as the timezone indicator. The XDS DTM data type also allows only for UTC as the timezone, therefore no transformation is necessary.
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:folder:last-update-time" DataType="http://www.w3.org/2001/XMLSchema#dateTime"> <AttributeValue>2004-12-25T21:20:10Z</AttributeValue> </Attribute>
Comment

Patient ID

IHE XDS Definition	4.2.3.4.7 as "Folder.patientId": "The patientId represents the primary subject of care of the Folder. The value of the patientId shall be the same for all new documents of a SubmissionSet. All DocumentEntries placed in a Folder shall have the same patiendId as the Folder."
ebXML Name	ExternalIdentifier with identificationScheme="urn:uuid:f64ffdf0-4b97-4e06-b79f-a52b38ec2f8a"
ebXML Example	<rim:ExternalIdentifier identificationScheme="urn:uuid:f64ffdf0-4b97-4e06-b79f-a52b38ec2f8a" value="6578946^^^&1.3.6.1.4.1.21367.2005.3.7&ISO" id="IdExample_057" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier"> <rim:Name> <rim:LocalizedString value="XDSFolder.patientId"/> </rim:Name> </rim:ExternalIdentifier>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:patient-id
XACML Data Type	urn:hl7-org:v3#II
XACML Attribute Value Content	Use CX.4 as root and CX.1 as extension
Attribute ID also used in	DocumentEntry, SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:patient-id" DataType="urn:hl7-org:v3#II"> <AttributeValue> <hl7:InstanceIdentifier extension="6578946" root="1.3.6.1.4.1.21367.2005.3.7"/> </AttributeValue> </Attribute>
Comment

Folder Unique ID

IHE XDS Definition	4.2.3.4.9 as "Folder.uniqueId": "Globally unique identifier for the folder instance assigned by the creating entity."
ebXML Name	ExternalIdentifier with identificationScheme="urn:uuid:75df8f67-9973-4fbe-a900-df66cefecc5a"
ebXML Example	<rim:ExternalIdentifier identificationScheme="urn:uuid:75df8f67-9973-4fbe-a900-df66cefecc5a" id="IdExample_059" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier" value="1.3.6.1.4.1.21367.2005.3.7.3670984664" registryObject="Folder01"> <rim:Name> <rim:LocalizedString value="XDSFolder.uniqueId"/> </rim:Name> </rim:ExternalIdentifier>
XACML Target Section	Resource
XACML Attribute ID	urn:oasis:names:tc:xacml:1.0:resource:resource-id
XACML Data Type	http://www.w3.org/2001/XMLSchema#string
XACML Attribute Value Content
Attribute ID also used in	DocumentEntry, SubmissionSet
XACML Example	<Attribute AttributeId="urn:oasis:names:tc:xacml:1.0:resource:resource-id" DataType="http://www.w3.org/2001/XMLSchema#string"> <AttributeValue>1.3.6.1.4.1.21367.2005.3.7.3670984664</AttributeValue> </Attribute>
Comment

Source System ID

IHE XDS Definition	4.2.3.3.9 as "SubmissionSet.sourceId": "The globally unique, immutable, identifier of the entity that contributed the SubmissionSet. When a "broker" is involved in sending SubmissionSets from a collection of client systems, it shall use a different sourceId for submissions from each separate system to allow for tracking."
ebXML Name	ExternalIdentifier with identificationScheme="urn:uuid:554ac39e-e3fe-47fe-b233-965d2a147832"
ebXML Example	<rim:ExternalIdentifier identificationScheme="urn:uuid:554ac39e-e3fe-47fe-b233-965d2a147832" value="1.3.6.1.4.1.21367.2005.3.7" id="IdExample_058" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier" registryObject="SubmissionSet01"> <rim:Name> <rim:LocalizedString value = "XDSSubmissionSet.sourceId"/> </rim:Name> </rim:ExternalIdentifier>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:source-system-id
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content	The implementor MUST include the sourceId of the SubmissionSet in which the folder entry was originally submitted. Please note that it is entered into the context as an attribute of the folder.
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007: source-system-id" DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue> 1.3.6.1.4.1.21367.2005.3.7</AttributeValue> </Attribute>
Comment

Resource Type

IHE XDS Definition	4.2.3.4 as Folder
ebXML Name	ExtrinsicObject with id="urn:uuid:fbeacdb7-5421-4474-9267-985007cd8855"
ebXML Example	<ExtrinsicObject id="urn:uuid:fbeacdb7-5421-4474-9267-985007cd8855" objectType="urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1" status="urn:oasis:names:tc:ebxml-regrep:StatusType:Approved"> ... </ExtrinsicObject>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe-d:cookbook:2013:resource-type
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content	for folders fixed to "urn:ihe:iti:xds-b:2007:folder"
Attribute ID also used in	DocumentEntry, SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe-d:cookbook:2013:resource-type" DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue>urn:ihe:iti:xds-b:2007:folder</AttributeValue> </Attribute>
Comment	The resource type attribute allows using the same AttributeID for attributes used multiple types (e.g. Author Person ID is used in SubmissionSet and in DocumentEntry). This allows for policy writers to create policies that are applicable to multiple types of resources (e.g. SubmissionSets and DocumentEntries) while retaining the ability to distinguish between them when necessary. TODO: Check if the folder ebXML is correct

Submission Set

Author Institution (Name)

IHE XDS Definition	4.2.3.1.4.1 as "authorInstitution": "Represents a specific healthcare facility under which the human and/or machines authored the document or SubmissionSet. This is a sub-attribute of the author attribute."
ebXML Name	classificationScheme="urn:uuid:a7058bb9-b4e4-4307-ba5b-e3f0ab85e12d"; Slot name="authorInstitution"
ebXML Example	<rim:Slot name="authorInstitution"> <rim:ValueList> <rim:Value>MercyHospital</rim:Value> <rim:Value>NY Mercy Hospital^^^^^^^^^1.2.3.9.1789.45</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:author-institution:name
XACML Data Type	http://www.w3.org/2001/XMLSchema#string
XACML Attribute Value Content	Use XON.1 of the authorInstitution
Attribute ID also used in	DocumentEntry
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:author-institution:name" DataType="http://www.w3.org/2001/XMLSchema#string"> <AttributeValue>NY Mercy Hospital</AttributeValue> </Attribute>
Comment

Author Institution (ID)

IHE XDS Definition	4.2.3.1.4.1 as "authorInstitution": "Represents a specific healthcare facility under which the human and/or machines authored the document or SubmissionSet. This is a sub-attribute of the author attribute."
ebXML Name	classificationScheme="urn:uuid:a7058bb9-b4e4-4307-ba5b-e3f0ab85e12d"; Slot name="authorInstitution"
ebXML Example	<rim:Slot name="authorInstitution"> <rim:ValueList> <rim:Value>MercyHospital</rim:Value> <rim:Value>NY Mercy Hospital^^^^^^^^^1.2.3.9.1789.45</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:author-institution:id
XACML Data Type	urn:hl7-org:v3#II
XACML Attribute Value Content	Use XON.6.2 as root and XON.10 as extension or (if XON.10 is an OID) use XON.10 as root
Attribute ID also used in	DocumentEntry
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:author-institution:id" DataType="urn:hl7-org:v3#II"> <AttributeValue> <hl7:InstanceIdentifier root="1.2.3.9.1789.45"/> </AttributeValue> </Attribute>
Comment

Author Person (Name)

IHE XDS Definition	4.2.3.1.4.2 as "authorPerson": "Represents the humans and/or machines that authored the document or SubmissionSet within the authorInstitution. The author may be the patient itself. This is a sub-attribute of the author attribute."
ebXML Name	classificationScheme="urn:uuid:a7058bb9-b4e4-4307-ba5b-e3f0ab85e12d"; Slot name="authorPerson"
ebXML Example	<rim:Slot name="authorPerson"> <rim:ValueList> <rim:Value>11375^Welby^Marcus^J^Jr. MD^Dr^^^&1.2.840.113619.6.197&ISO</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:author-person:name
XACML Data Type	http://www.w3.org/2001/XMLSchema#string
XACML Attribute Value Content	Should use the format <prefix> <first name> <second and further given names> <last name> <suffix>
Attribute ID also used in	DocumentEntry
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:author-person:name" DataType="http://www.w3.org/2001/XMLSchema#string"> <AttributeValue>Dr Marcus J Welby Jr. MD</AttributeValue> </Attribute>
Comment

Author Person (ID)

IHE XDS Definition	4.2.3.1.4.2 as "authorPerson": "Represents the humans and/or machines that authored the document or SubmissionSet within the authorInstitution. The author may be the patient itself. This is a sub-attribute of the author attribute."
ebXML Name	classificationScheme="urn:uuid:a7058bb9-b4e4-4307-ba5b-e3f0ab85e12d"; Slot name="authorPerson"
ebXML Example	<rim:Slot name="authorPerson"> <rim:ValueList> <rim:Value>11375^Welby^Marcus^J^Jr. MD^Dr^^^&1.2.840.113619.6.197&ISO</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:author-person:id
XACML Data Type	urn:hl7-org:v3#II
XACML Attribute Value Content	Use XCN.9 as root and XCN.1 as extension or (if XCN.1 is an OID) use XCN.1 as root
Attribute ID also used in	DocumentEntry
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:author-person:id" DataType="urn:hl7-org:v3#II"> <AttributeValue> <hl7:InstanceIdentifier extension="11375" root="1.2.840.113619.6.197"/> </AttributeValue> </Attribute>
Comment

Author Role

IHE XDS Definition	4.2.3.1.4.3 as "authorRole": "A string that represents the role of the author with respect to the patient at the time the document or SubmissionSet was created. This is a sub-attribute of the author attribute."
ebXML Name	classificationScheme="urn:uuid:a7058bb9-b4e4-4307-ba5b-e3f0ab85e12d"; Slot name="authorRole"
ebXML Example	<rim:Slot name="authorRole"> <rim:ValueList> <rim:Value>PCP^^^&2.16.840.1.113883.19.9&ISO</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:author-role
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content	Use CX.4.2 as codeSystem and CX.1 as extension; if it is not coded as a CX data type, a default codeSystem must be defined for the affinity domain
Attribute ID also used in	DocumentEntry
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:author-role" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="PCP" codeSystem="2.16.840.1.113883.19.9"/> </AttributeValue> </Attribute>
Comment

Author Speciality

IHE XDS Definition	4.2.3.1.4.4 as "authorSpeciality": "Represents a specific specialty within a healthcare facility under which the human and/or machines authored the document or SubmissionSet. This is a sub-attribute of the author attribute."
ebXML Name	classificationScheme="urn:uuid:a7058bb9-b4e4-4307-ba5b-e3f0ab85e12d"; Slot name="authorSpeciality"
ebXML Example	<rim:Slot name="authorSpeciality"> <rim:ValueList> <rim:Value>Cardiology^^^&2.16.840.1.113883.19.10&ISO</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:author-speciality
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content	Use CX.4.2 as codeSystem and CX.1 as extension; if it is not coded as a CX data type, a default codeSystem must be defined for the affinity domain
Attribute ID also used in	DocumentEntry
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:author-speciality" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="Cardiology" codeSystem="2.16.840.1.113883.19.10"/> </AttributeValue> </Attribute>
Comment

Availability Status

IHE XDS Definition	4.2.3.3.2 as "SubmissionSet.availabilityStatus": "Represents the status of the SubmissionSet. Since the deprecation of SubmissionSets is not allowed, this value shall always be Approved."
ebXML Name	"status" attribute of "RegistryPackage" element
ebXML Example	<rim:RegistryPackage id="urn:uuid:fbeacdb7-5421-4474-9267-985007cd8855" status="urn:oasis:names:tc:ebxml-regrep:StatusType:Approved"> ...
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:availability-status
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content	"urn:oasis:names:tc:ebxml-regrep:StatusType:Approved" or "urn:oasis:names:tc:ebxml-regrep:StatusType:Deprecated" or any other valid availabilityStatus defined by an extension or by a new profile
Attribute ID also used in	DocumentEntry, Folder
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:availability-status" DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue>urn:oasis:names:tc:ebxml-regrep:StatusType:Approved</AttributeValue> </Attribute>
Comment

Content Type Code

IHE XDS Definition	4.2.3.3.4 as "SubmissionSet.contentTypeCode": "The code specifying the type of clinical activity that resulted in placing these DocumentEntries, Folders, and/or Associations in this SubmissionSet. These values are to be drawn from a vocabulary defined by the creating entity that contributed the SubmissionSet."
ebXML Name	classificationScheme="urn:uuid:aa543740-bdda-424e-8c96-df4873be8500"
ebXML Example	<rim:Classification classificationScheme="urn:uuid:aa543740-bdda-424e-8c96-df4873be8500" classifiedObject="ExampleSubmissionSet" id="IdExample_056" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification" nodeRepresentation="47046-8"> <rim:Name> <rim:LocalizedString value="Summary of death" /> </rim:Name> <rim:Slot name="codingScheme"> <rim:ValueList> <rim:Value>2.16.840.1.113883.6.1</rim:Value> </rim:ValueList> </rim:Slot> </rim:Classification>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:submission-set:content-type
XACML Data Type	urn:hl7-org:v3#CV
XACML Attribute Value Content
Attribute ID also used in	-
XACML Example	<Attribute AttributeId=" urn:ihe:iti:xds-b:2007:submission-set:content-type" DataType="urn:hl7-org:v3#CV"> <AttributeValue> <hl7:CodedValue code="47046-8" codeSystem="2.16.840.1.113883.6.1"/> </AttributeValue> </Attribute>
Comment

Home Community ID

IHE XDS Definition	4.2.3.3.6 as "SubmissionSet.homeCommunityId": "A globally unique identifier for a community."
ebXML Name	"home" attribute of RegistryPackage element
ebXML Example	<rim:RegistryPackage home="urn:oid:2.16.840.1.113883.19.14" ...> ... </rim:RegistryPackage >
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:home-community-id
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content	The identifier MUST be an Object Identifier (OID), using the urn format ("urn:oid:" appended with the OID)
Attribute ID also used in	DocumentEntry, SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:home-community-id" DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue>urn:oid:2.16.840.1.113883.19.14</AttributeValue> </Attribute>
Comment

Patient ID

IHE XDS Definition	4.2.3.3.8 as "SubmissionSet.patientId": "The patientId represents the primary subject of care of the SubmissionSet."
ebXML Name	ExternalIdentifier with identificationScheme="urn:uuid:6b5aea1a-874d-4603-a4bc-96a0a7b38446"
ebXML Example	<rim:ExternalIdentifier identificationScheme="urn:uuid:6b5aea1a-874d-4603-a4bc-96a0a7b38446" value="6578946^^^&1.3.6.1.4.1.21367.2005.3.7&ISO" id="IdExample_057" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier" registryObject="SubmissionSet01"> <rim:Name> <rim:LocalizedString value="XDSSubmissionSet.patientId"/> </rim:Name> </rim:ExternalIdentifier>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:patient-id
XACML Data Type	urn:hl7-org:v3#II
XACML Attribute Value Content	Use CX.4 as root and CX.1 as extension
Attribute ID also used in	Folder, SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:patient-id" DataType="urn:hl7-org:v3#II"> <AttributeValue> <hl7:InstanceIdentifier extension="6578946" root="1.3.6.1.4.1.21367.2005.3.7"/></AttributeValue> </Attribute>
Comment

Source System ID

IHE XDS Definition	4.2.3.3.9 as "SubmissionSet.sourceId": "The globally unique, immutable, identifier of the entity that contributed the SubmissionSet. When a "broker" is involved in sending SubmissionSets from a collection of client systems, it shall use a different sourceId for submissions from each separate system to allow for tracking."
ebXML Name	ExternalIdentifier with identificationScheme="urn:uuid:554ac39e-e3fe-47fe-b233-965d2a147832"
ebXML Example	<rim:ExternalIdentifier identificationScheme="urn:uuid:554ac39e-e3fe-47fe-b233-965d2a147832" value="1.3.6.1.4.1.21367.2005.3.7" id="IdExample_058" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier" registryObject="SubmissionSet01"> <rim:Name> <rim:LocalizedString value="XDSSubmissionSet.sourceId"/> </rim:Name> </rim:ExternalIdentifier>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:source-system-id
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:source-system-id" DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue>1.3.6.1.4.1.21367.2005.3.7</AttributeValue> </Attribute>
Comment

Creation Time

IHE XDS Definition	4.2.3.3.10 as "SubmissionSet.creationTime": "Represents the point in time at the creating entity when the Submission Set was submitted. This shall be provided by the submitting system."
ebXML Name	Slot name = "submissionTime"
ebXML Example	<rim:Slot name="submissionTime"> <rim:ValueList> <rim:Value>20041225212010</rim:Value> </rim:ValueList> </rim:Slot>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe:iti:xds-b:2007:submission-set:submission-time
XACML Data Type	http://www.w3.org/2001/XMLSchema#dateTime
XACML Attribute Value Content	This point in time must be transformed into a valid instance of an XML dateTime (which is based of ISO8601). This may involve adding date or time components, because in XDS the DTM data type allows for partial dates. To transform incomplete submissionTimes into dateTime instances the implementor MUST use the smallest instant covered by the partial date. E.g. "200904" would be transformed to "2009-04-01T00:00:00Z". The XACML dateTime must be expressed as UTC using ‚Z‘ as the timezone indicator. The XDS DTM data type also allows only for UTC as the timezone, therefore no transformation is necessary.
Attribute ID also used in	-
XACML Example	<Attribute AttributeId="urn:ihe:iti:xds-b:2007:submission-set:submission-time" DataType="http://www.w3.org/2001/XMLSchema#dateTime"> <AttributeValue>2004-12-25T21:20:10Z</AttributeValue> </Attribute>
Comment	This includes a provision to deal with partial dates. However, as the submissionTime will very likely be set automatically at transmission time, this is very unlikely to be used.

SubmissionSet Unique ID

IHE XDS Definition	4.2.3.3.12 as "SubmissionSet.uniqueId": "The globally unique identifier for the SubmissionSet assigned by the entity that contributed the SubmissionSet."
ebXML Name	ExternalIdentifier with identificationScheme = "urn:uuid:96fdda7c-d067-4183-912e-bf5ee74998a8"
ebXML Example	<rim:ExternalIdentifier identificationScheme="urn:uuid:96fdda7c-d067-4183-912e-bf5ee74998a8" id="IdExample_059" objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier" value="1.2.3.4.5" registryObject="SubmissionSet01"> <rim:Name> <rim:LocalizedString value="XDSSubmissionSet.uniqueId"/> </rim:Name> </rim:ExternalIdentifier>
XACML Target Section	Resource
XACML Attribute ID	urn:oasis:names:tc:xacml:1.0:resource:resource-id
XACML Data Type	http://www.w3.org/2001/XMLSchema#string
XACML Attribute Value Content
Attribute ID also used in	DocumentEntry, Folder
XACML Example	<Attribute AttributeId="urn:oasis:names:tc:xacml:1.0:resource:resource-id" DataType="http://www.w3.org/2001/XMLSchema#string"> <AttributeValue>1.2.3.4.5</AttributeValue> </Attribute>
Comment

Resource Type

IHE XDS Definition	4.2.3.3 as SubmissionSet
ebXML Name	ExtrinsicObject with id="urn:uuid:fbeacdb7-5421-4474-9267-985007cd8855"
ebXML Example	<ExtrinsicObject id="urn:uuid:fbeacdb7-5421-4474-9267-985007cd8855" objectType="urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1" status="urn:oasis:names:tc:ebxml-regrep:StatusType:Approved"> ... </ExtrinsicObject>
XACML Target Section	Resource
XACML Attribute ID	urn:ihe-d:cookbook:2013:resource-type
XACML Data Type	http://www.w3.org/2001/XMLSchema#anyURI
XACML Attribute Value Content	for folders fixed to "urn:ihe:iti:xds-b:2007:submission-set"
Attribute ID also used in	DocumentEntry, SubmissionSet
XACML Example	<Attribute AttributeId="urn:ihe-d:cookbook:2013:resource-type " DataType="http://www.w3.org/2001/XMLSchema#anyURI"> <AttributeValue>urn:ihe:iti:xds-b:2007:submission-set</AttributeValue> </Attribute>
Comment	The resource type attribute allows using the same AttributeID for attributes used multiple types (e.g. Author Person ID is used in SubmissionSet and in DocumentEntry). This allows for policy writers to create policies that are applicable to multiple types of resources (e.g. SubmissionSets and DocumentEntries) while retaining the ability to distinguish between them when necessary. TODO: Check if the RegistryPackage ID and the objectType for submissionSets is correct

@@ Zeile 33: / Zeile 33: @@
 This function SHALL take two arguments of data-type "urn:hl7-org:v3#CV" and SHALL return an "<nowiki>http://www.w3.org/2001/XMLSchema#boolean</nowiki>". The function SHALL return "True" if and only if the "code" attribute of both of its arguments are equal according to the function "urn:oasis:names:tc:xacml:1.0:function:string-equal" AND the "codeSystem" attribute of both of its arguments are equal according to the function "urn:oasis:names:tc:xacml:1.0:function:string-equal". Otherwise, it SHALL return "False".
+* urn:hl7-org:v3:function:II-to-string
+This function SHALL take one argument of data-type "urn:hl7-org:v3#II" and SHALL return an "<nowiki>http://www.w3.org/2001/XMLSchema#string</nowiki>". The function SHALL return the "root" attribute of its argument if and only if the "extension" attribute of its arguments is empty. Otherwise, it SHALL return the concatenation of the "root" attribute of its argument, the character "@", and the "extension" attribute of its argument (in this order) according to the function "urn:oasis:names:tc:xacml:2.0:function:string-concatenate".
 * urn:hl7-org:v3:function:II-equal
 This function SHALL take two arguments of data-type "urn:hl7-org:v3#II" and SHALL return an "<nowiki>http://www.w3.org/2001/XMLSchema#boolean</nowiki>". The function SHALL return "True" a) if and only if the extension attribute is empty and the "root" attribute of both of its arguments are equal according to the function "urn:oasis:names:tc:xacml:1.0:function:string-equal" OR b) if and only if the "extension" attribute of both of its arguments are equal according to the function "urn:oasis:names:tc:xacml:1.0:function:string-equal" AND the "root" attribute of both of its arguments are equal according to the function "urn:oasis:names:tc:xacml:1.0:function:string-equal". Otherwise, it SHALL return "False".
+* urn:hl7-org:v3:function:II-match
+This function SHALL take one argument of data-type "urn:hl7-org:v3#II" and one of data-type "http://www.w3.org/2001/XMLSchema#string". It SHALL return an "http://www.w3.org/2001/XMLSchema#boolean". The function SHALL convert the "urn:hl7-org:v3#II" to a "http://www.w3.org/2001/XMLSchema#string" according to the rules of "urn:hl7-org:v3:function:II-to-string". The function SHALL then return "True" if and only if the converted "urn:hl7-org:v3#II" argument is equal to the "http://www.w3.org/2001/XMLSchema#string" argument according to the rules of "urn:oasis:names:tc:xacml:1.0:function:string-equal". Otherwise, it SHALL return "False".
+* urn:ihe-d:cookbook:function:2015:SeR-URN-to-CV
+This function SHALL take one argument of data-type "http://www.w3.org/2001/XMLSchema#anyURI" that adheres to the IHE Secure Retrieval Profile definition of a URN encoded coded value and SHALL return a "urn:hl7-org:v3#CV". The function SHALL seperate the first argument into tokens seperated by the colon (":") character. Each token must be URN-decoded to replace the percentage encoded characters by the actual characters. Each token MUST NOT include the colon character. The function SHALL then create a "urn:hl7-org:v3#CV" using the 6th token as the "codeSystem" element and the 8th token as the "code" element. The function MAY additionally use the 7th token as the "codeSystemName" element and the 9th token as the "displayName" element. The function SHALL then return the created "urn:hl7-org:v3#CV".
+* urn:ihe-d:cookbook:function:2015:CV-equal-to-SeR-URN
+This function SHALL take one argument of data-type "urn:hl7-org:v3#CV" and one of data-type "http://www.w3.org/2001/XMLSchema#anyURI" that adheres to the IHE Secure Retrieval Profile definition of a URN encoded coded value. It SHALL return an "http://www.w3.org/2001/XMLSchema#boolean". The function SHALL convert the "http://www.w3.org/2001/XMLSchema#anyURI"´to a "urn:hl7-org:v3#CV" using the function "urn:ihe-d:cookbook:function:2015:anyURI-to-CV". The function SHALL then evaluate the first argument to the converted second argument according to the function "urn:hl7-org:v3:function:CV-equal". If the comparison yields a "True", the function SHALL return "True". Otherwise it shall return "False".
 ==IHE XUA User Attributes Binding==
@@ Zeile 80: / Zeile 97: @@
 |
-urn:oasis:names:tc:xacml:2.0:subject:subject-id
+urn:oasis:names:tc:xacml:1.0:subject:subject-id
 |-
@@ Zeile 103: / Zeile 120: @@
 <syntaxhighlight lang="xml">
 <Attribute
-         AttributeId="urn:oasis:names:tc:xacml:2.0:subject:subject-id"
+         AttributeId="urn:oasis:names:tc:xacml:1.0:subject:subject-id"
          DataType="http://www.w3.org/2001/XMLSchema#string">
      <AttributeValue>user1</AttributeValue>
@@ Zeile 2.628: / Zeile 2.645: @@
 |
-urn:oasis:names:tc:xacml:2.0:resource:resource-id
+urn:oasis:names:tc:xacml:1.0:resource:resource-id
 |-
@@ Zeile 2.658: / Zeile 2.675: @@
 <syntaxhighlight lang="xml">
 <Attribute
-         AttributeId="urn:oasis:names:tc:xacml:2.0:resource:resource-id"
+         AttributeId="urn:oasis:names:tc:xacml:1.0:resource:resource-id"
          DataType="http://www.w3.org/2001/XMLSchema#string">
      <AttributeValue>1.2.3.4.5.6.78901.2345.6.7^123456</AttributeValue>
@@ Zeile 3.513: / Zeile 3.530: @@
 |
-urn:oasis:names:tc:xacml:2.0:resource:resource-id
+urn:oasis:names:tc:xacml:1.0:resource:resource-id
 |-
@@ Zeile 3.543: / Zeile 3.560: @@
 <syntaxhighlight lang="xml">
 <Attribute
-         AttributeId="urn:oasis:names:tc:xacml:2.0:resource:resource-id"
+         AttributeId="urn:oasis:names:tc:xacml:1.0:resource:resource-id"
          DataType="http://www.w3.org/2001/XMLSchema#string">
      <AttributeValue>1.3.6.1.4.1.21367.2005.3.7.3670984664</AttributeValue>
@@ Zeile 4.833: / Zeile 4.850: @@
 |
-urn:oasis:names:tc:xacml:2.0:resource:resource-id
+urn:oasis:names:tc:xacml:1.0:resource:resource-id
 |-
@@ Zeile 4.863: / Zeile 4.880: @@
 <syntaxhighlight lang="xml">
 <Attribute
-         AttributeId="urn:oasis:names:tc:xacml:2.0:resource:resource-id"
+         AttributeId="urn:oasis:names:tc:xacml:1.0:resource:resource-id"
          DataType="http://www.w3.org/2001/XMLSchema#string">
      <AttributeValue>1.2.3.4.5</AttributeValue>

IHE-XACML Binding

Aktuelle Version vom 16. März 2015, 16:41 Uhr

Inhaltsverzeichnis

Custom Data Types (and related Comparison Functions) used for the bindings

Custom Data Types

Custom Comparison Functions

IHE XUA User Attributes Binding

User ID

User’s Full Name

User Organization

User Organization ID

User Home Community ID

National Provider Identifier (NPI)

User Role

Purpose Of Use

IHE XDS Document Attribute Bindings

Author Institution (Name)

Author Institution (ID)

Author Person (Name)

Author Person (ID)

Author Role

Author Speciality

Availability Status

Class Code

Confidentiality Code

Creation Time

Event Code

Healthcare Facility Type Code

Home Community ID

Legal Authenticator

Patient ID

Practice Setting Code

Repository Unique ID

Service Start Time

Service Stop Time

Source Patient ID

Type Code

Document Unique ID

Related Folder Unique ID

Related Folder Code

Source System ID

Resource Type

IHE Folder Attributes

Availability Status

Code

Home Community ID

Last Update Time

Patient ID

Folder Unique ID

Source System ID

Resource Type

Submission Set

Author Institution (Name)

Author Institution (ID)

Author Person (Name)

Author Person (ID)

Author Role

Author Speciality

Availability Status

Content Type Code

Home Community ID

Patient ID

Source System ID

Creation Time

SubmissionSet Unique ID

Resource Type

Navigationsmenü

Suche