IHE Germany - Value Sets for XDS
0.3.7 - draft Germany flag

IHE Germany - Value Sets for XDS, published by IHE Deutschland e.V., Berlin, Deutschland. This guide is not an authorized publication; it is the continuous build for version 0.3.7 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE-Germany/ITI.XDS.VS/ and changes regularly. See the Directory of published versions

Logical Model: DocumentEntry - Detailed Descriptions

Page standards status: Draft Maturity Level: 2

Definitions for the DocumentEntry logical model.

Guidance on how to interpret the contents of this table can be found here

0. Document
Definition

Document Entry

ShortDocument Entry (LM)
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Document.title
Definition

title of document

Shorttitle of document
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. Document.uniqueId
Definition

identifier of document

Shortidentifier of document
Control1..1
TypeExtension(Identifier) (Extension Type: Identifier)
6. Document.uri
Definition

URI of document

ShortURI of document
Control1..1
TypeExtension(Identifier) (Extension Type: Identifier)
8. Document.class
Definition

Class Code

Shortclass Code of the document
Control1..1
BindingThe codes SHALL be taken from IHE XDS Class Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSclassCode)
TypeCodeableConcept
10. Document.type
Definition

Type Code

Shorttype Code
Control1..1
BindingThe codes SHALL be taken from IHE XDS Type Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDStypeCode)
TypeCodeableConcept
12. Document.author
Definition

author

Shortauthor
Control0..1
TypeExtension(Identifier) (Extension Type: Identifier)
14. Document.availabilityStatus
Definition

Availability Status

Shortavailability status of the document
Control0..1
BindingThe codes SHALL be taken from IHE XDS Availability Status
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSavailabilityStatusCode)
TypeCodeableConcept
16. Document.comments
Definition

Comments

ShortComments
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Document.confidentiality
Definition

Confidentiality Code

Shortconfidentiality Code
Control1..1
BindingThe codes SHALL be taken from IHE XDS Confidentiality Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSconfidentialityCode)
TypeCodeableConcept
20. Document.creationTime
Definition

timestamp of creation of document

Shorttimestamp of creation of document
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. Document.event
Definition

Class Code

Shortclass Code of the document
Control0..*
BindingThe codes SHALL be taken from IHE XDS Event Code List
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSeventCodeList)
TypeCodeableConcept
24. Document.language
Definition

Language Code

Shortlanguage of the document
Control1..*
BindingThe codes SHALL be taken from IHE XDS Language Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode)
TypeCodeableConcept
26. Document.format
Definition

Format Code

Shortformat of the document
Control1..1
BindingThe codes SHALL be taken from IHE XDS Format Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSformatCode)
TypeCodeableConcept
28. Document.size
Definition

size of document

Shortsize of document
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. Document.hash
Definition

hash value

Shorthash value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. Document.practiceSetting
Definition

Practice Setting

Shortpractice setting
Control0..1
BindingThe codes SHALL be taken from IHE XDS Practice Setting Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSpracticeSettingCode)
TypeCodeableConcept
34. Document.healthcareFacilityTypeCode
Definition

Healthcare Facility Type Code**

Shorthealthcare facility type code
Control1..1
BindingThe codes SHALL be taken from IHE XDS Healthcare Facility Type Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDShealthcareFacilityTypeCode)
TypeCodeableConcept
36. Document.legalAuthenticator
Definition

legal authenticator of the document

Shortlegal authenticator of the document
Control0..1
TypeExtension(Identifier) (Extension Type: Identifier)
38. Document.limitedMetadata
Definition

metadata

Shortmetadata
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. Document.mimeType
Definition

mime type

Shortmime type
Control1..1
TypeCodeableConcept
42. Document.objectType
Definition

mime type

Shortmime type
Control1..1
TypeCodeableConcept
44. Document.sourcePatientID
Definition

identifier of patient

Shortidentifier of patient
Control1..1
TypeExtension(Identifier) (Extension Type: Identifier)
46. Document.sourcePatientInfo
Definition

additional information to patient

Shortadditional information to patient
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. Document.referenceIdList
Definition

list of reference identifiers

Shortlist of reference identifiers
Control0..*
TypeExtension(Identifier) (Extension Type: Identifier)
50. Document.repositoryUniqueID
Definition

identifier of repository

Shortidentifier of repository
Control0..1
TypeExtension(Identifier) (Extension Type: Identifier)
52. Document.serviceStartTime
Definition

start of service

Shortstart of service
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. Document.serviceEndTime
Definition

end of service

Shortend of service
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. Document
Definition

Document Entry

ShortDocument Entry (LM)
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Document.title
Definition

title of document

Shorttitle of document
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. Document.uniqueId
Definition

identifier of document

Shortidentifier of document
Control1..1
TypeExtension(Identifier) (Extension Type: Identifier)
6. Document.uri
Definition

URI of document

ShortURI of document
Control1..1
TypeExtension(Identifier) (Extension Type: Identifier)
8. Document.class
Definition

Class Code

Shortclass Code of the document
Control1..1
BindingThe codes SHALL be taken from IHE XDS Class Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSclassCode)
TypeCodeableConcept
10. Document.type
Definition

Type Code

Shorttype Code
Control1..1
BindingThe codes SHALL be taken from IHE XDS Type Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDStypeCode)
TypeCodeableConcept
12. Document.author
Definition

author

Shortauthor
Control0..1
TypeExtension(Identifier) (Extension Type: Identifier)
14. Document.availabilityStatus
Definition

Availability Status

Shortavailability status of the document
Control0..1
BindingThe codes SHALL be taken from IHE XDS Availability Status
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSavailabilityStatusCode)
TypeCodeableConcept
16. Document.comments
Definition

Comments

ShortComments
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Document.confidentiality
Definition

Confidentiality Code

Shortconfidentiality Code
Control1..1
BindingThe codes SHALL be taken from IHE XDS Confidentiality Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSconfidentialityCode)
TypeCodeableConcept
20. Document.creationTime
Definition

timestamp of creation of document

Shorttimestamp of creation of document
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. Document.event
Definition

Class Code

Shortclass Code of the document
Control0..*
BindingThe codes SHALL be taken from IHE XDS Event Code List
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSeventCodeList)
TypeCodeableConcept
24. Document.language
Definition

Language Code

Shortlanguage of the document
Control1..*
BindingThe codes SHALL be taken from IHE XDS Language Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode)
TypeCodeableConcept
26. Document.format
Definition

Format Code

Shortformat of the document
Control1..1
BindingThe codes SHALL be taken from IHE XDS Format Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSformatCode)
TypeCodeableConcept
28. Document.size
Definition

size of document

Shortsize of document
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. Document.hash
Definition

hash value

Shorthash value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. Document.practiceSetting
Definition

Practice Setting

Shortpractice setting
Control0..1
BindingThe codes SHALL be taken from IHE XDS Practice Setting Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSpracticeSettingCode)
TypeCodeableConcept
34. Document.healthcareFacilityTypeCode
Definition

Healthcare Facility Type Code**

Shorthealthcare facility type code
Control1..1
BindingThe codes SHALL be taken from IHE XDS Healthcare Facility Type Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDShealthcareFacilityTypeCode)
TypeCodeableConcept
36. Document.legalAuthenticator
Definition

legal authenticator of the document

Shortlegal authenticator of the document
Control0..1
TypeExtension(Identifier) (Extension Type: Identifier)
38. Document.limitedMetadata
Definition

metadata

Shortmetadata
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. Document.mimeType
Definition

mime type

Shortmime type
Control1..1
TypeCodeableConcept
42. Document.objectType
Definition

mime type

Shortmime type
Control1..1
TypeCodeableConcept
44. Document.sourcePatientID
Definition

identifier of patient

Shortidentifier of patient
Control1..1
TypeExtension(Identifier) (Extension Type: Identifier)
46. Document.sourcePatientInfo
Definition

additional information to patient

Shortadditional information to patient
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. Document.referenceIdList
Definition

list of reference identifiers

Shortlist of reference identifiers
Control0..*
TypeExtension(Identifier) (Extension Type: Identifier)
50. Document.repositoryUniqueID
Definition

identifier of repository

Shortidentifier of repository
Control0..1
TypeExtension(Identifier) (Extension Type: Identifier)
52. Document.serviceStartTime
Definition

start of service

Shortstart of service
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. Document.serviceEndTime
Definition

end of service

Shortend of service
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. Document
Definition

Document Entry

ShortDocument Entry (LM)
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Document.title
Definition

title of document

Shorttitle of document
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. Document.uniqueId
Definition

identifier of document

Shortidentifier of document
Control1..1
TypeExtension(Identifier) (Extension Type: Identifier)
6. Document.uri
Definition

URI of document

ShortURI of document
Control1..1
TypeExtension(Identifier) (Extension Type: Identifier)
8. Document.class
Definition

Class Code

Shortclass Code of the document
Control1..1
BindingThe codes SHALL be taken from IHE XDS Class Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSclassCode)
TypeCodeableConcept
10. Document.type
Definition

Type Code

Shorttype Code
Control1..1
BindingThe codes SHALL be taken from IHE XDS Type Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDStypeCode)
TypeCodeableConcept
12. Document.author
Definition

author

Shortauthor
Control0..1
TypeExtension(Identifier) (Extension Type: Identifier)
14. Document.availabilityStatus
Definition

Availability Status

Shortavailability status of the document
Control0..1
BindingThe codes SHALL be taken from IHE XDS Availability Status
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSavailabilityStatusCode)
TypeCodeableConcept
16. Document.comments
Definition

Comments

ShortComments
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Document.confidentiality
Definition

Confidentiality Code

Shortconfidentiality Code
Control1..1
BindingThe codes SHALL be taken from IHE XDS Confidentiality Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSconfidentialityCode)
TypeCodeableConcept
20. Document.creationTime
Definition

timestamp of creation of document

Shorttimestamp of creation of document
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. Document.event
Definition

Class Code

Shortclass Code of the document
Control0..*
BindingThe codes SHALL be taken from IHE XDS Event Code List
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSeventCodeList)
TypeCodeableConcept
24. Document.language
Definition

Language Code

Shortlanguage of the document
Control1..*
BindingThe codes SHALL be taken from IHE XDS Language Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode)
TypeCodeableConcept
26. Document.format
Definition

Format Code

Shortformat of the document
Control1..1
BindingThe codes SHALL be taken from IHE XDS Format Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSformatCode)
TypeCodeableConcept
28. Document.size
Definition

size of document

Shortsize of document
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. Document.hash
Definition

hash value

Shorthash value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. Document.practiceSetting
Definition

Practice Setting

Shortpractice setting
Control0..1
BindingThe codes SHALL be taken from IHE XDS Practice Setting Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSpracticeSettingCode)
TypeCodeableConcept
34. Document.healthcareFacilityTypeCode
Definition

Healthcare Facility Type Code**

Shorthealthcare facility type code
Control1..1
BindingThe codes SHALL be taken from IHE XDS Healthcare Facility Type Code
(required to http://www.ihe-d.de/fhir/ValueSet/IHEXDShealthcareFacilityTypeCode)
TypeCodeableConcept
36. Document.legalAuthenticator
Definition

legal authenticator of the document

Shortlegal authenticator of the document
Control0..1
TypeExtension(Identifier) (Extension Type: Identifier)
38. Document.limitedMetadata
Definition

metadata

Shortmetadata
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. Document.mimeType
Definition

mime type

Shortmime type
Control1..1
TypeCodeableConcept
42. Document.objectType
Definition

mime type

Shortmime type
Control1..1
TypeCodeableConcept
44. Document.sourcePatientID
Definition

identifier of patient

Shortidentifier of patient
Control1..1
TypeExtension(Identifier) (Extension Type: Identifier)
46. Document.sourcePatientInfo
Definition

additional information to patient

Shortadditional information to patient
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. Document.referenceIdList
Definition

list of reference identifiers

Shortlist of reference identifiers
Control0..*
TypeExtension(Identifier) (Extension Type: Identifier)
50. Document.repositoryUniqueID
Definition

identifier of repository

Shortidentifier of repository
Control0..1
TypeExtension(Identifier) (Extension Type: Identifier)
52. Document.serviceStartTime
Definition

start of service

Shortstart of service
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. Document.serviceEndTime
Definition

end of service

Shortend of service
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension