CH Core (R4)
1.0.0 - Trial use

This page is part of the CH Core (R4) (v1.0.0: STU 1). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

StructureDefinition: CHCoreDocumentReference

Base definition for a document reference with the CH Core profiles.

The official URL for this profile is:

http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-documentreference

Formal Views of Profile Content

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

This structure is derived from DocumentReference

Summary

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceCH Core DocumentReference
... status 1..1codecurrent | superseded | entered-in-error
... type 0..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred)
... category 0..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (preferred)
... content 1..*BackboneElementDocument referenced
.... attachment 1..1AttachmentWhere to access the document
..... contentType I0..1codeMime type of the content, with charset etc.
ch-docref-1: The following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
..... language 0..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
.... format 0..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (preferred)
... context 0..1BackboneElementClinical context of document
.... facilityType 0..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (preferred)
.... practiceSetting 0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (preferred)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference I0..*DocumentReferenceCH Core DocumentReference
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... masterIdentifier ΣI0..1IdentifierMaster Version Specific Identifier
... identifier ΣI0..*IdentifierOther identifiers for the document
... status ?!ΣI1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required)
... docStatus ΣI0..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type ΣI0..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred)
... category ΣI0..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (preferred)
... subject ΣI0..1Reference(Patient | Practitioner | Group | Device)Who/what is the subject of the document
... date ΣI0..1instantWhen this document reference was created
... author ΣI0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what authored the document
... authenticator I0..1Reference(Practitioner | PractitionerRole | Organization)Who/what authenticated the document
... custodian I0..1Reference(Organization)Organization which maintains the document
... relatesTo ΣI0..*BackboneElementRelationships to other documents
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target ΣI1..1Reference(DocumentReference)Target of the relationship
... description ΣI0..1stringHuman-readable description
... securityLabel ΣI0..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (preferred)
... content ΣI1..*BackboneElementDocument referenced
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment ΣI1..1AttachmentWhere to access the document
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType ΣI0..1codeMime type of the content, with charset etc.
Binding: Mime Types (required)
ch-docref-1: The following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language ΣI0..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
Example General: en-AU
..... data I0..1base64BinaryData inline, base64ed
..... url ΣI0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size ΣI0..1unsignedIntNumber of bytes of content (if url provided)
..... hash ΣI0..1base64BinaryHash of the data (sha-1, base64ed)
..... title ΣI0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation ΣI0..1dateTimeDate attachment was first created
.... format ΣI0..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (preferred)
... context ΣI0..1BackboneElementClinical context of document
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... encounter I0..*Reference(Encounter | EpisodeOfCare)Context of the document content
.... event I0..*CodeableConceptMain clinical acts documented
Binding: v3 Code System ActCode (example)
.... period ΣI0..1PeriodTime of service that is being documented
.... facilityType I0..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (preferred)
.... practiceSetting I0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (preferred)
.... sourcePatientInfo I0..1Reference(Patient)Patient demographics from source
.... related I0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format

This structure is derived from DocumentReference

Summary

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceCH Core DocumentReference
... status 1..1codecurrent | superseded | entered-in-error
... type 0..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred)
... category 0..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (preferred)
... content 1..*BackboneElementDocument referenced
.... attachment 1..1AttachmentWhere to access the document
..... contentType I0..1codeMime type of the content, with charset etc.
ch-docref-1: The following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
..... language 0..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
.... format 0..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (preferred)
... context 0..1BackboneElementClinical context of document
.... facilityType 0..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (preferred)
.... practiceSetting 0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (preferred)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference I0..*DocumentReferenceCH Core DocumentReference
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... masterIdentifier ΣI0..1IdentifierMaster Version Specific Identifier
... identifier ΣI0..*IdentifierOther identifiers for the document
... status ?!ΣI1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required)
... docStatus ΣI0..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type ΣI0..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred)
... category ΣI0..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (preferred)
... subject ΣI0..1Reference(Patient | Practitioner | Group | Device)Who/what is the subject of the document
... date ΣI0..1instantWhen this document reference was created
... author ΣI0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what authored the document
... authenticator I0..1Reference(Practitioner | PractitionerRole | Organization)Who/what authenticated the document
... custodian I0..1Reference(Organization)Organization which maintains the document
... relatesTo ΣI0..*BackboneElementRelationships to other documents
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target ΣI1..1Reference(DocumentReference)Target of the relationship
... description ΣI0..1stringHuman-readable description
... securityLabel ΣI0..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (preferred)
... content ΣI1..*BackboneElementDocument referenced
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment ΣI1..1AttachmentWhere to access the document
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType ΣI0..1codeMime type of the content, with charset etc.
Binding: Mime Types (required)
ch-docref-1: The following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language ΣI0..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
Example General: en-AU
..... data I0..1base64BinaryData inline, base64ed
..... url ΣI0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size ΣI0..1unsignedIntNumber of bytes of content (if url provided)
..... hash ΣI0..1base64BinaryHash of the data (sha-1, base64ed)
..... title ΣI0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation ΣI0..1dateTimeDate attachment was first created
.... format ΣI0..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (preferred)
... context ΣI0..1BackboneElementClinical context of document
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... encounter I0..*Reference(Encounter | EpisodeOfCare)Context of the document content
.... event I0..*CodeableConceptMain clinical acts documented
Binding: v3 Code System ActCode (example)
.... period ΣI0..1PeriodTime of service that is being documented
.... facilityType I0..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (preferred)
.... practiceSetting I0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (preferred)
.... sourcePatientInfo I0..1Reference(Patient)Patient demographics from source
.... related I0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
DocumentReference.languagepreferredCommonLanguages
Max Binding: AllLanguages
DocumentReference.statusrequiredDocumentReferenceStatus
DocumentReference.docStatusrequiredCompositionStatus
DocumentReference.typepreferredDocumentEntryTypeCode
DocumentReference.categorypreferredDocumentEntryClassCode
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
DocumentReference.securityLabelpreferredDocumentEntryConfidentialityCode
DocumentReference.content.attachment.contentTyperequiredMime Types
DocumentReference.content.attachment.languagepreferredDocumentEntryLanguageCode
DocumentReference.content.formatpreferredDocumentEntryFormatCode
DocumentReference.context.eventexamplev3.ActCode
DocumentReference.context.facilityTypepreferredDocumentEntryHealthcareFacilityTypeCode
DocumentReference.context.practiceSettingpreferredDocumentEntryPracticeSettingCode

Constraints

Constraints

IdPathDetailsRequirements
dom-2DocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3DocumentReferenceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4DocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5DocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6DocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1DocumentReference.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DocumentReference.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DocumentReference.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DocumentReference.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DocumentReference.masterIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.docStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.authenticatorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.custodianAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.relatesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.relatesTo.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DocumentReference.relatesTo.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DocumentReference.relatesTo.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DocumentReference.relatesTo.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DocumentReference.relatesTo.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.relatesTo.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.securityLabelAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.contentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.content.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DocumentReference.content.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DocumentReference.content.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DocumentReference.content.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DocumentReference.content.attachmentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.content.attachment.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DocumentReference.content.attachment.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DocumentReference.content.attachment.contentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ch-docref-1DocumentReference.content.attachment.contentTypeThe following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
: exists()
ele-1DocumentReference.content.attachment.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.content.attachment.dataAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.content.attachment.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.content.attachment.sizeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.content.attachment.hashAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.content.attachment.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.content.attachment.creationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.content.formatAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.contextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.context.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DocumentReference.context.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DocumentReference.context.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DocumentReference.context.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DocumentReference.context.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.context.eventAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.context.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.context.facilityTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.context.practiceSettingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.context.sourcePatientInfoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DocumentReference.context.relatedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())