eHealth Infrastructure (v2019.5)
The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference
This profile builds on DocumentReference.
This profile was published on Wed May 08 06:17:13 UTC 2019 as a draft by null.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from DocumentReference
This structure is derived from DocumentReference
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DocumentReference | I | 0..* | A reference to a document | |
  id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier |
| identifier | Σ | 0..* | Identifier | Other identifiers for the document |
| status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) |
| docStatus | Σ | 0..1 | code | preliminary | final | appended | amended | entered-in-error Binding: CompositionStatus (required) |
| type | Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentType (required) |
| class | Σ | 0..1 | CodeableConcept | Categorization of document Binding: DocumentClass (required) |
 subject | Σ | 0..1 | Reference(eHealth Patient | eHealth Practitioner | Group | eHealth Device) | Who/what is the subject of the document |
| created | Σ | 0..1 | dateTime | Document creation time |
| indexed | Σ | 1..1 | instant | When this document reference was created |
| author | Σ | 0..* | Reference(eHealth Practitioner | eHealth Organization | eHealth Device | eHealth Patient | eHealth RelatedPerson) | Who and/or what authored the document |
| authenticator | Σ | 0..1 | Reference(eHealth Practitioner | eHealth Organization) | Who/what authenticated the document |
| custodian | Σ | 0..1 | Reference(eHealth Organization) | Organization which maintains the document |
| relatesTo | ?!ΣI | 0..* | BackboneElement | Relationships to other documents |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
 target | Σ | 1..1 | Reference(ehealth-documentreference) | Target of the relationship |
| description | Σ | 0..1 | string | Human-readable description (title) |
| securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible) |
| content | ΣI | 1..* | BackboneElement | Document referenced |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| attachment | Σ | 1..1 | Attachment | Where to access the document |
| format | Σ | 0..1 | Coding | Format/content rules for the document Binding: FormatCodes (required) |
| context | ΣI | 0..1 | BackboneElement | Clinical context of document |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| encounter | Σ | 0..1 | Reference(Encounter) | Context of the document content |
| event | Σ | 0..* | CodeableConcept | Main clinical acts documented Binding: EventTypeCodes (required) |
| period | Σ | 0..1 | Period | Time of service that is being documented |
| facilityType | Σ | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodes (required) |
| practiceSetting | Σ | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodes (required) |
| sourcePatientInfo | Σ | 0..1 | Reference(eHealth Patient) | Patient demographics from source |
| related | ΣI | 0..* | BackboneElement | Related identifiers or resources |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Identifier of related objects or events |
| ref | Σ | 0..1 | Reference(Resource) | Related Resource |
| Documentation for this format | ||||
This structure is derived from DocumentReference
Differential View
This structure is derived from DocumentReference
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DocumentReference | I | 0..* | A reference to a document | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier |
| identifier | Σ | 0..* | Identifier | Other identifiers for the document |
| status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) |
| docStatus | Σ | 0..1 | code | preliminary | final | appended | amended | entered-in-error Binding: CompositionStatus (required) |
| type | Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentType (required) |
| class | Σ | 0..1 | CodeableConcept | Categorization of document Binding: DocumentClass (required) |
| subject | Σ | 0..1 | Reference(eHealth Patient | eHealth Practitioner | Group | eHealth Device) | Who/what is the subject of the document |
| created | Σ | 0..1 | dateTime | Document creation time |
| indexed | Σ | 1..1 | instant | When this document reference was created |
| author | Σ | 0..* | Reference(eHealth Practitioner | eHealth Organization | eHealth Device | eHealth Patient | eHealth RelatedPerson) | Who and/or what authored the document |
| authenticator | Σ | 0..1 | Reference(eHealth Practitioner | eHealth Organization) | Who/what authenticated the document |
| custodian | Σ | 0..1 | Reference(eHealth Organization) | Organization which maintains the document |
| relatesTo | ?!ΣI | 0..* | BackboneElement | Relationships to other documents |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
| target | Σ | 1..1 | Reference(ehealth-documentreference) | Target of the relationship |
| description | Σ | 0..1 | string | Human-readable description (title) |
| securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible) |
| content | ΣI | 1..* | BackboneElement | Document referenced |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| attachment | Σ | 1..1 | Attachment | Where to access the document |
| format | Σ | 0..1 | Coding | Format/content rules for the document Binding: FormatCodes (required) |
| context | ΣI | 0..1 | BackboneElement | Clinical context of document |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| encounter | Σ | 0..1 | Reference(Encounter) | Context of the document content |
| event | Σ | 0..* | CodeableConcept | Main clinical acts documented Binding: EventTypeCodes (required) |
| period | Σ | 0..1 | Period | Time of service that is being documented |
| facilityType | Σ | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodes (required) |
| practiceSetting | Σ | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodes (required) |
| sourcePatientInfo | Σ | 0..1 | Reference(eHealth Patient) | Patient demographics from source |
| related | ΣI | 0..* | BackboneElement | Related identifiers or resources |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Identifier of related objects or events |
| ref | Σ | 0..1 | Reference(Resource) | Related Resource |
| Documentation for this format | ||||
| Path | Name | Conformance | ValueSet |
| DocumentReference.language | Common Languages | extensible | Common Languages |
| DocumentReference.status | DocumentReferenceStatus | required | DocumentReferenceStatus |
| DocumentReference.docStatus | CompositionStatus | required | CompositionStatus |
| DocumentReference.type | DocumentType | required | DocumentType |
| DocumentReference.class | DocumentClass | required | DocumentClass |
| DocumentReference.relatesTo.code | DocumentRelationshipType | required | DocumentRelationshipType |
| DocumentReference.securityLabel | All Security Labels | extensible | All Security Labels |
| DocumentReference.content.format | FormatCodes | required | FormatCodes |
| DocumentReference.context.event | EventTypeCodes | required | EventTypeCodes |
| DocumentReference.context.facilityType | FacilityTypeCodes | required | FacilityTypeCodes |
| DocumentReference.context.practiceSetting | PracticeSettingCodes | required | PracticeSettingCodes |
| Id | Path | Details | Requirements |
| dom-2 | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | DocumentReference | If 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-3 | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ele-1 | DocumentReference.relatesTo | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | DocumentReference.content | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | DocumentReference.context | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | DocumentReference.context.related | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |