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: Document Entry (Profile)

Official URL: http://www.ihe-d.de/fhir/StructureDefinition/DocumentEntryProfile Version: 0.1.0
Standards status: Draft Maturity Level: 2 Computable Name: DocumentEntryProfile

Copyright/Legal: IHE Deutschland e.V.

Document Entry: Die zu unterstützenden Attribute werden über ein Profil festgelegt.

Usage:

  • This Logical Model is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from DocumentEntry

NameFlagsCard.TypeDescription & Constraintsdoco
.. Document 0..* DocumentEntry
Elements defined in Ancestors:title, uniqueId, uri, class, type, author, availabilityStatus, comments, confidentiality, creationTime, event, language, format, size, hash, practiceSetting, healthcareFacilityTypeCode, legalAuthenticator, limitedMetadata, mimeType, objectType, sourcePatientID, sourcePatientInfo, referenceIdList, repositoryUniqueID, serviceStartTime, serviceEndTime
Document Entry (LM)
Instances of this logical model are not marked to be the target of a Reference
... class S 1..1 CodeableConcept class Code of the document
... type S 1..1 CodeableConcept type Code
... availabilityStatus S 0..1 CodeableConcept availability status of the document
... language S 1..* CodeableConcept language of the document
... format S 1..1 CodeableConcept format of the document
... practiceSetting S 0..1 CodeableConcept practice setting
... healthcareFacilityTypeCode S 1..1 CodeableConcept healthcare facility type code
... mimeType S 1..1 CodeableConcept mime type
... objectType S 1..1 CodeableConcept mime type
... sourcePatientID S 1..1 Identifier(5.1.0) identifier of patient
... serviceStartTime S 1..1 dateTime start of service
... serviceEndTime S 1..1 dateTime end of service

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Document 0..* DocumentEntry
Elements defined in Ancestors:title, uniqueId, uri, class, type, author, availabilityStatus, comments, confidentiality, creationTime, event, language, format, size, hash, practiceSetting, healthcareFacilityTypeCode, legalAuthenticator, limitedMetadata, mimeType, objectType, sourcePatientID, sourcePatientInfo, referenceIdList, repositoryUniqueID, serviceStartTime, serviceEndTime
Document Entry (LM)
Instances of this logical model are not marked to be the target of a Reference
... title 1..1 string title of document
... uniqueId 1..1 Identifier(5.1.0) identifier of document
... uri 1..1 Identifier(5.1.0) URI of document
... type S 1..1 CodeableConcept type Code
Binding: IHE XDS Type Code (required)
... availabilityStatus S 0..1 CodeableConcept availability status of the document
Binding: IHE XDS Availability Status (required)
... confidentiality S 1..1 CodeableConcept confidentiality Code
Binding: IHE XDS Confidentiality Code (required)
... creationTime 1..1 dateTime timestamp of creation of document
... language S 1..* CodeableConcept language of the document
Binding: IHE XDS Language Code (required)
... format S 1..1 CodeableConcept format of the document
Binding: IHE XDS Format Code (required)
... practiceSetting S 0..1 CodeableConcept practice setting
Binding: IHE XDS Practice Setting Code (required)
... healthcareFacilityTypeCode S 1..1 CodeableConcept healthcare facility type code
Binding: IHE XDS Healthcare Facility Type Code (required)
... mimeType S 1..1 CodeableConcept mime type
... objectType S 1..1 CodeableConcept mime type
... sourcePatientID S 1..1 Identifier(5.1.0) identifier of patient
... serviceStartTime S 1..1 dateTime start of service
... serviceEndTime S 1..1 dateTime end of service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Document.classrequiredIHEXDSclassCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSclassCode
from this IG
Document.typerequiredIHEXDStypeCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDStypeCode
from this IG
Document.availabilityStatusrequiredIHEXDSavailabilityStatusCode (a valid code from Verfügbarkeitsstatus von Dokumenten)
http://www.ihe-d.de/fhir/ValueSet/IHEXDSavailabilityStatusCode
from this IG
Document.confidentialityrequiredIHEXDSconfidentialityCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSconfidentialityCode
from this IG
Document.languagerequiredIHEXDSlanguageCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode
from this IG
Document.formatrequiredIHEXDSformatCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSformatCode
from this IG
Document.practiceSettingrequiredIHEXDSpracticeSettingCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSpracticeSettingCode
from this IG
Document.healthcareFacilityTypeCoderequiredIHEXDShealthcareFacilityTypeCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDShealthcareFacilityTypeCode
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Document 0..* DocumentEntry
Elements defined in Ancestors:title, uniqueId, uri, class, type, author, availabilityStatus, comments, confidentiality, creationTime, event, language, format, size, hash, practiceSetting, healthcareFacilityTypeCode, legalAuthenticator, limitedMetadata, mimeType, objectType, sourcePatientID, sourcePatientInfo, referenceIdList, repositoryUniqueID, serviceStartTime, serviceEndTime
Document Entry (LM)
Instances of this logical model are not marked to be the target of a Reference
... title 1..1 string title of document
... uniqueId 1..1 Identifier(5.1.0) identifier of document
... uri 1..1 Identifier(5.1.0) URI of document
... class S 1..1 CodeableConcept class Code of the document
Binding: IHE XDS Class Code (required)
... type S 1..1 CodeableConcept type Code
Binding: IHE XDS Type Code (required)
... author 0..1 Identifier(5.1.0) author
... availabilityStatus S 0..1 CodeableConcept availability status of the document
Binding: IHE XDS Availability Status (required)
... comments 0..1 string Comments
... confidentiality S 1..1 CodeableConcept confidentiality Code
Binding: IHE XDS Confidentiality Code (required)
... creationTime 1..1 dateTime timestamp of creation of document
... event 0..* CodeableConcept class Code of the document
Binding: IHE XDS Event Code List (required)
... language S 1..* CodeableConcept language of the document
Binding: IHE XDS Language Code (required)
... format S 1..1 CodeableConcept format of the document
Binding: IHE XDS Format Code (required)
... size 0..1 integer size of document
... hash 0..1 string hash value
... practiceSetting S 0..1 CodeableConcept practice setting
Binding: IHE XDS Practice Setting Code (required)
... healthcareFacilityTypeCode S 1..1 CodeableConcept healthcare facility type code
Binding: IHE XDS Healthcare Facility Type Code (required)
... legalAuthenticator 0..1 Identifier(5.1.0) legal authenticator of the document
... limitedMetadata 0..1 string metadata
... mimeType S 1..1 CodeableConcept mime type
... objectType S 1..1 CodeableConcept mime type
... sourcePatientID S 1..1 Identifier(5.1.0) identifier of patient
... sourcePatientInfo 0..1 string additional information to patient
... referenceIdList 0..* Identifier(5.1.0) list of reference identifiers
... repositoryUniqueID 0..1 Identifier(5.1.0) identifier of repository
... serviceStartTime S 1..1 dateTime start of service
... serviceEndTime S 1..1 dateTime end of service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Document.classrequiredIHEXDSclassCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSclassCode
from this IG
Document.typerequiredIHEXDStypeCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDStypeCode
from this IG
Document.availabilityStatusrequiredIHEXDSavailabilityStatusCode (a valid code from Verfügbarkeitsstatus von Dokumenten)
http://www.ihe-d.de/fhir/ValueSet/IHEXDSavailabilityStatusCode
from this IG
Document.confidentialityrequiredIHEXDSconfidentialityCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSconfidentialityCode
from this IG
Document.eventrequiredIHEXDSeventCodeList
http://www.ihe-d.de/fhir/ValueSet/IHEXDSeventCodeList
from this IG
Document.languagerequiredIHEXDSlanguageCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode
from this IG
Document.formatrequiredIHEXDSformatCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSformatCode
from this IG
Document.practiceSettingrequiredIHEXDSpracticeSettingCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSpracticeSettingCode
from this IG
Document.healthcareFacilityTypeCoderequiredIHEXDShealthcareFacilityTypeCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDShealthcareFacilityTypeCode
from this IG

This structure is derived from DocumentEntry

Summary

Must-Support: 13 elements

Maturity: 2

Differential View

This structure is derived from DocumentEntry

NameFlagsCard.TypeDescription & Constraintsdoco
.. Document 0..* DocumentEntry
Elements defined in Ancestors:title, uniqueId, uri, class, type, author, availabilityStatus, comments, confidentiality, creationTime, event, language, format, size, hash, practiceSetting, healthcareFacilityTypeCode, legalAuthenticator, limitedMetadata, mimeType, objectType, sourcePatientID, sourcePatientInfo, referenceIdList, repositoryUniqueID, serviceStartTime, serviceEndTime
Document Entry (LM)
Instances of this logical model are not marked to be the target of a Reference
... class S 1..1 CodeableConcept class Code of the document
... type S 1..1 CodeableConcept type Code
... availabilityStatus S 0..1 CodeableConcept availability status of the document
... language S 1..* CodeableConcept language of the document
... format S 1..1 CodeableConcept format of the document
... practiceSetting S 0..1 CodeableConcept practice setting
... healthcareFacilityTypeCode S 1..1 CodeableConcept healthcare facility type code
... mimeType S 1..1 CodeableConcept mime type
... objectType S 1..1 CodeableConcept mime type
... sourcePatientID S 1..1 Identifier(5.1.0) identifier of patient
... serviceStartTime S 1..1 dateTime start of service
... serviceEndTime S 1..1 dateTime end of service

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Document 0..* DocumentEntry
Elements defined in Ancestors:title, uniqueId, uri, class, type, author, availabilityStatus, comments, confidentiality, creationTime, event, language, format, size, hash, practiceSetting, healthcareFacilityTypeCode, legalAuthenticator, limitedMetadata, mimeType, objectType, sourcePatientID, sourcePatientInfo, referenceIdList, repositoryUniqueID, serviceStartTime, serviceEndTime
Document Entry (LM)
Instances of this logical model are not marked to be the target of a Reference
... title 1..1 string title of document
... uniqueId 1..1 Identifier(5.1.0) identifier of document
... uri 1..1 Identifier(5.1.0) URI of document
... type S 1..1 CodeableConcept type Code
Binding: IHE XDS Type Code (required)
... availabilityStatus S 0..1 CodeableConcept availability status of the document
Binding: IHE XDS Availability Status (required)
... confidentiality S 1..1 CodeableConcept confidentiality Code
Binding: IHE XDS Confidentiality Code (required)
... creationTime 1..1 dateTime timestamp of creation of document
... language S 1..* CodeableConcept language of the document
Binding: IHE XDS Language Code (required)
... format S 1..1 CodeableConcept format of the document
Binding: IHE XDS Format Code (required)
... practiceSetting S 0..1 CodeableConcept practice setting
Binding: IHE XDS Practice Setting Code (required)
... healthcareFacilityTypeCode S 1..1 CodeableConcept healthcare facility type code
Binding: IHE XDS Healthcare Facility Type Code (required)
... mimeType S 1..1 CodeableConcept mime type
... objectType S 1..1 CodeableConcept mime type
... sourcePatientID S 1..1 Identifier(5.1.0) identifier of patient
... serviceStartTime S 1..1 dateTime start of service
... serviceEndTime S 1..1 dateTime end of service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Document.classrequiredIHEXDSclassCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSclassCode
from this IG
Document.typerequiredIHEXDStypeCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDStypeCode
from this IG
Document.availabilityStatusrequiredIHEXDSavailabilityStatusCode (a valid code from Verfügbarkeitsstatus von Dokumenten)
http://www.ihe-d.de/fhir/ValueSet/IHEXDSavailabilityStatusCode
from this IG
Document.confidentialityrequiredIHEXDSconfidentialityCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSconfidentialityCode
from this IG
Document.languagerequiredIHEXDSlanguageCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode
from this IG
Document.formatrequiredIHEXDSformatCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSformatCode
from this IG
Document.practiceSettingrequiredIHEXDSpracticeSettingCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSpracticeSettingCode
from this IG
Document.healthcareFacilityTypeCoderequiredIHEXDShealthcareFacilityTypeCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDShealthcareFacilityTypeCode
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Document 0..* DocumentEntry
Elements defined in Ancestors:title, uniqueId, uri, class, type, author, availabilityStatus, comments, confidentiality, creationTime, event, language, format, size, hash, practiceSetting, healthcareFacilityTypeCode, legalAuthenticator, limitedMetadata, mimeType, objectType, sourcePatientID, sourcePatientInfo, referenceIdList, repositoryUniqueID, serviceStartTime, serviceEndTime
Document Entry (LM)
Instances of this logical model are not marked to be the target of a Reference
... title 1..1 string title of document
... uniqueId 1..1 Identifier(5.1.0) identifier of document
... uri 1..1 Identifier(5.1.0) URI of document
... class S 1..1 CodeableConcept class Code of the document
Binding: IHE XDS Class Code (required)
... type S 1..1 CodeableConcept type Code
Binding: IHE XDS Type Code (required)
... author 0..1 Identifier(5.1.0) author
... availabilityStatus S 0..1 CodeableConcept availability status of the document
Binding: IHE XDS Availability Status (required)
... comments 0..1 string Comments
... confidentiality S 1..1 CodeableConcept confidentiality Code
Binding: IHE XDS Confidentiality Code (required)
... creationTime 1..1 dateTime timestamp of creation of document
... event 0..* CodeableConcept class Code of the document
Binding: IHE XDS Event Code List (required)
... language S 1..* CodeableConcept language of the document
Binding: IHE XDS Language Code (required)
... format S 1..1 CodeableConcept format of the document
Binding: IHE XDS Format Code (required)
... size 0..1 integer size of document
... hash 0..1 string hash value
... practiceSetting S 0..1 CodeableConcept practice setting
Binding: IHE XDS Practice Setting Code (required)
... healthcareFacilityTypeCode S 1..1 CodeableConcept healthcare facility type code
Binding: IHE XDS Healthcare Facility Type Code (required)
... legalAuthenticator 0..1 Identifier(5.1.0) legal authenticator of the document
... limitedMetadata 0..1 string metadata
... mimeType S 1..1 CodeableConcept mime type
... objectType S 1..1 CodeableConcept mime type
... sourcePatientID S 1..1 Identifier(5.1.0) identifier of patient
... sourcePatientInfo 0..1 string additional information to patient
... referenceIdList 0..* Identifier(5.1.0) list of reference identifiers
... repositoryUniqueID 0..1 Identifier(5.1.0) identifier of repository
... serviceStartTime S 1..1 dateTime start of service
... serviceEndTime S 1..1 dateTime end of service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Document.classrequiredIHEXDSclassCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSclassCode
from this IG
Document.typerequiredIHEXDStypeCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDStypeCode
from this IG
Document.availabilityStatusrequiredIHEXDSavailabilityStatusCode (a valid code from Verfügbarkeitsstatus von Dokumenten)
http://www.ihe-d.de/fhir/ValueSet/IHEXDSavailabilityStatusCode
from this IG
Document.confidentialityrequiredIHEXDSconfidentialityCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSconfidentialityCode
from this IG
Document.eventrequiredIHEXDSeventCodeList
http://www.ihe-d.de/fhir/ValueSet/IHEXDSeventCodeList
from this IG
Document.languagerequiredIHEXDSlanguageCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode
from this IG
Document.formatrequiredIHEXDSformatCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSformatCode
from this IG
Document.practiceSettingrequiredIHEXDSpracticeSettingCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSpracticeSettingCode
from this IG
Document.healthcareFacilityTypeCoderequiredIHEXDShealthcareFacilityTypeCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDShealthcareFacilityTypeCode
from this IG

This structure is derived from DocumentEntry

Summary

Must-Support: 13 elements

Maturity: 2

 

Other representations of profile: CSV, Excel