IHE Germany - Value Sets for XDS
0.3.7 - draft
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
Page standards status: Draft | Maturity Level: 2 |
Definitions for the DocumentEntryProfile logical model.
Guidance on how to interpret the contents of this table can be found here
0. Document | |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Document.class | |
Must Support | true |
4. Document.type | |
Must Support | true |
6. Document.availabilityStatus | |
Must Support | true |
8. Document.confidentiality | |
Must Support | true |
10. Document.language | |
Must Support | true |
12. Document.format | |
Must Support | true |
14. Document.practiceSetting | |
Must Support | true |
16. Document.healthcareFacilityTypeCode | |
Must Support | true |
18. Document.mimeType | |
Must Support | true |
20. Document.objectType | |
Must Support | true |
22. Document.sourcePatientID | |
Must Support | true |
24. Document.serviceStartTime | |
Must Support | true |
26. Document.serviceEndTime | |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. Document | |
Definition | Document Entry |
Short | Document Entry (LM) |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Document.title | |
Definition | title of document |
Short | title of document |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
4. Document.uniqueId | |
Definition | identifier of document |
Short | identifier of document |
Control | 1..1 |
Type | Extension(Identifier) (Extension Type: Identifier) |
6. Document.uri | |
Definition | URI of document |
Short | URI of document |
Control | 1..1 |
Type | Extension(Identifier) (Extension Type: Identifier) |
8. Document.class | |
Definition | Class Code |
Short | class Code of the document |
Control | 1..1 |
Binding | The codes SHALL be taken from IHE XDS Class Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSclassCode ) |
Type | CodeableConcept |
Must Support | true |
10. Document.type | |
Definition | Type Code |
Short | type Code |
Control | 1..1 |
Binding | The codes SHALL be taken from IHE XDS Type Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDStypeCode ) |
Type | CodeableConcept |
Must Support | true |
12. Document.availabilityStatus | |
Definition | Availability Status |
Short | availability status of the document |
Control | 0..1 |
Binding | The codes SHALL be taken from IHE XDS Availability Status (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSavailabilityStatusCode ) |
Type | CodeableConcept |
Must Support | true |
14. Document.confidentiality | |
Definition | Confidentiality Code |
Short | confidentiality Code |
Control | 1..1 |
Binding | The codes SHALL be taken from IHE XDS Confidentiality Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSconfidentialityCode ) |
Type | CodeableConcept |
Must Support | true |
16. Document.creationTime | |
Definition | timestamp of creation of document |
Short | timestamp of creation of document |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
18. Document.language | |
Definition | Language Code |
Short | language of the document |
Control | 1..* |
Binding | The codes SHALL be taken from IHE XDS Language Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode ) |
Type | CodeableConcept |
Must Support | true |
20. Document.format | |
Definition | Format Code |
Short | format of the document |
Control | 1..1 |
Binding | The codes SHALL be taken from IHE XDS Format Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSformatCode ) |
Type | CodeableConcept |
Must Support | true |
22. Document.practiceSetting | |
Definition | Practice Setting |
Short | practice setting |
Control | 0..1 |
Binding | The codes SHALL be taken from IHE XDS Practice Setting Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSpracticeSettingCode ) |
Type | CodeableConcept |
Must Support | true |
24. Document.healthcareFacilityTypeCode | |
Definition | Healthcare Facility Type Code** |
Short | healthcare facility type code |
Control | 1..1 |
Binding | The codes SHALL be taken from IHE XDS Healthcare Facility Type Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDShealthcareFacilityTypeCode ) |
Type | CodeableConcept |
Must Support | true |
26. Document.mimeType | |
Definition | mime type |
Short | mime type |
Control | 1..1 |
Type | CodeableConcept |
Must Support | true |
28. Document.objectType | |
Definition | mime type |
Short | mime type |
Control | 1..1 |
Type | CodeableConcept |
Must Support | true |
30. Document.sourcePatientID | |
Definition | identifier of patient |
Short | identifier of patient |
Control | 1..1 |
Type | Extension(Identifier) (Extension Type: Identifier) |
Must Support | true |
32. Document.serviceStartTime | |
Definition | start of service |
Short | start of service |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
34. Document.serviceEndTime | |
Definition | end of service |
Short | end of service |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. Document | |
Definition | Document Entry |
Short | Document Entry (LM) |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Document.title | |
Definition | title of document |
Short | title of document |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
4. Document.uniqueId | |
Definition | identifier of document |
Short | identifier of document |
Control | 1..1 |
Type | Extension(Identifier) (Extension Type: Identifier) |
6. Document.uri | |
Definition | URI of document |
Short | URI of document |
Control | 1..1 |
Type | Extension(Identifier) (Extension Type: Identifier) |
8. Document.class | |
Definition | Class Code |
Short | class Code of the document |
Control | 1..1 |
Binding | The codes SHALL be taken from IHE XDS Class Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSclassCode ) |
Type | CodeableConcept |
Must Support | true |
10. Document.type | |
Definition | Type Code |
Short | type Code |
Control | 1..1 |
Binding | The codes SHALL be taken from IHE XDS Type Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDStypeCode ) |
Type | CodeableConcept |
Must Support | true |
12. Document.author | |
Definition | author |
Short | author |
Control | 0..1 |
Type | Extension(Identifier) (Extension Type: Identifier) |
14. Document.availabilityStatus | |
Definition | Availability Status |
Short | availability status of the document |
Control | 0..1 |
Binding | The codes SHALL be taken from IHE XDS Availability Status (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSavailabilityStatusCode ) |
Type | CodeableConcept |
Must Support | true |
16. Document.comments | |
Definition | Comments |
Short | Comments |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
18. Document.confidentiality | |
Definition | Confidentiality Code |
Short | confidentiality Code |
Control | 1..1 |
Binding | The codes SHALL be taken from IHE XDS Confidentiality Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSconfidentialityCode ) |
Type | CodeableConcept |
Must Support | true |
20. Document.creationTime | |
Definition | timestamp of creation of document |
Short | timestamp of creation of document |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
22. Document.event | |
Definition | Class Code |
Short | class Code of the document |
Control | 0..* |
Binding | The codes SHALL be taken from IHE XDS Event Code List (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSeventCodeList ) |
Type | CodeableConcept |
24. Document.language | |
Definition | Language Code |
Short | language of the document |
Control | 1..* |
Binding | The codes SHALL be taken from IHE XDS Language Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode ) |
Type | CodeableConcept |
Must Support | true |
26. Document.format | |
Definition | Format Code |
Short | format of the document |
Control | 1..1 |
Binding | The codes SHALL be taken from IHE XDS Format Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSformatCode ) |
Type | CodeableConcept |
Must Support | true |
28. Document.size | |
Definition | size of document |
Short | size of document |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. Document.hash | |
Definition | hash value |
Short | hash value |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
32. Document.practiceSetting | |
Definition | Practice Setting |
Short | practice setting |
Control | 0..1 |
Binding | The codes SHALL be taken from IHE XDS Practice Setting Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDSpracticeSettingCode ) |
Type | CodeableConcept |
Must Support | true |
34. Document.healthcareFacilityTypeCode | |
Definition | Healthcare Facility Type Code** |
Short | healthcare facility type code |
Control | 1..1 |
Binding | The codes SHALL be taken from IHE XDS Healthcare Facility Type Code (required to http://www.ihe-d.de/fhir/ValueSet/IHEXDShealthcareFacilityTypeCode ) |
Type | CodeableConcept |
Must Support | true |
36. Document.legalAuthenticator | |
Definition | legal authenticator of the document |
Short | legal authenticator of the document |
Control | 0..1 |
Type | Extension(Identifier) (Extension Type: Identifier) |
38. Document.limitedMetadata | |
Definition | metadata |
Short | metadata |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. Document.mimeType | |
Definition | mime type |
Short | mime type |
Control | 1..1 |
Type | CodeableConcept |
Must Support | true |
42. Document.objectType | |
Definition | mime type |
Short | mime type |
Control | 1..1 |
Type | CodeableConcept |
Must Support | true |
44. Document.sourcePatientID | |
Definition | identifier of patient |
Short | identifier of patient |
Control | 1..1 |
Type | Extension(Identifier) (Extension Type: Identifier) |
Must Support | true |
46. Document.sourcePatientInfo | |
Definition | additional information to patient |
Short | additional information to patient |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
48. Document.referenceIdList | |
Definition | list of reference identifiers |
Short | list of reference identifiers |
Control | 0..* |
Type | Extension(Identifier) (Extension Type: Identifier) |
50. Document.repositoryUniqueID | |
Definition | identifier of repository |
Short | identifier of repository |
Control | 0..1 |
Type | Extension(Identifier) (Extension Type: Identifier) |
52. Document.serviceStartTime | |
Definition | start of service |
Short | start of service |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
54. Document.serviceEndTime | |
Definition | end of service |
Short | end of service |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |