The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-correspondance
This is the profile for correspondance messages, which are also known as "XDIS91" in existing terminology. It covers messages between health professionals concerning a specific patient/subject, eg. a descriptions of a specific treatment going from hospital to doctor. . The correspondance message may contain different types of attachments. These are reflected in the provided example "correspondance-all-types", which contains all four types. The type of the individual attachments are specified using the referencetype extension. The types are:
For remaining document data, see the corresponding value sets.
This profile builds on Communication.
This profile was published on Fri May 22 12:11:22 UTC 2020 as a draft by ehealth.sundhed.dk.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Communication
Summary
Mandatory: 17 elements
Fixed Value: 6 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-authorizationTime | 1..1 | dateTime | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime | |
identifier | 1..* | (Slice Definition) | Unique identifier Slice: Unordered, Open by value:system | |
identifier:envelopeIdentifier | 1..1 | Identifier | Use value set "CorrespondanceEnvelopeIdentifier" | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ehealth.sundhed.dk/correspondance-envelope-identifier | |
identifier:letterIdentifier | 1..1 | Identifier | Use value set "CorrespondanceEnvelopeIdentifier" | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ehealth.sundhed.dk/correspondance-letter-identifier | |
definition | 0..* | Reference(PlanDefinition | ActivityDefinition) {r} | Instantiates protocol or definition | |
basedOn | 0..* | Reference(Resource) {r} | Request fulfilled by this communication | |
partOf | 0..* | Reference(Resource) {r} | Part of this action | |
category | 0..* | (Slice Definition) | Message category Slice: Unordered, Open by value:coding.system | |
category:acknowledgementCode | 1..1 | CodeableConcept | Use value set "Correspondance acknowledgement code" | |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-acknowledgement-code | |
category:versionCode | 1..1 | CodeableConcept | Use value set "Correspondance version code" | |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-version-code | |
category:typeCode | 1..1 | CodeableConcept | Use value set "Correspondance type code" | |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-type-code | |
category:statusCode | 1..1 | CodeableConcept | Use value set "Correspondance status code" | |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-status-code | |
subject | 1..1 | Reference(Patient | Group) {r} | Focus of message | |
identifier | 0..1 | Identifier | Logical reference, when literal reference is not known | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-correspondance-address | 0..1 | (Complex) | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-correspondance-address | |
recipient | 1..1 | Reference(Organization | Patient | Practitioner) {r} | Message recipient | |
display | 1..1 | string | Text alternative for the resource | |
topic | 0..* | Reference(Resource) {r} | Focal resources | |
context | 0..1 | Reference(Encounter | EpisodeOfCare) {r} | Encounter or episode leading to message | |
sent | 1..1 | dateTime | When sent | |
sender | 1..1 | Reference(Organization | Patient | Practitioner) {r} | Message sender | |
display | 1..1 | string | Text alternative for the resource | |
reasonReference | 0..* | Reference(Condition | Observation) {r} | Why was communication done? | |
payload | 1..* | BackboneElement | Message payload | |
contentAttachment:contentAttachment | 1..1 | Attachment | Message part content | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-referencetype | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referencetype | |
ehealth-reference-description | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reference-description | |
ehealth-identifier | 0..1 | Identifier | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-identifier | |
note | ||||
author[x] | 0..1 | Individual responsible for the annotation | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson) | |||
authorString | string | |||
Documentation for this format |
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | I | 0..* | Communication | A record of information transmitted from a sender to a receiver |
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) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-authorizationTime | I | 1..1 | dateTime | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | (Slice Definition) | Unique identifier Slice: Unordered, Open by value:system |
identifier:envelopeIdentifier | Σ | 1..1 | Identifier | Use value set "CorrespondanceEnvelopeIdentifier" |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ehealth.sundhed.dk/correspondance-envelope-identifier |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
identifier:letterIdentifier | Σ | 1..1 | Identifier | Use value set "CorrespondanceEnvelopeIdentifier" |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ehealth.sundhed.dk/correspondance-letter-identifier |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
definition | Σ | 0..* | Reference(PlanDefinition | ActivityDefinition) {r} | Instantiates protocol or definition |
basedOn | Σ | 0..* | Reference(Resource) {r} | Request fulfilled by this communication |
partOf | Σ | 0..* | Reference(Resource) {r} | Part of this action |
status | ?!Σ | 1..1 | code | preparation | in-progress | suspended | aborted | completed | entered-in-error Binding: EventStatus (required) |
notDone | ?!Σ | 0..1 | boolean | Communication did not occur |
notDoneReason | ΣI | 0..1 | CodeableConcept | Why communication did not occur Binding: CommunicationNotDoneReason (example) |
category | 0..* | (Slice Definition) | Message category Slice: Unordered, Open by value:coding.system Binding: CommunicationCategory (example) | |
category:acknowledgementCode | 1..1 | CodeableConcept | Use value set "Correspondance acknowledgement code" Binding: CommunicationCategory (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-acknowledgement-code |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
category:versionCode | 1..1 | CodeableConcept | Use value set "Correspondance version code" Binding: CommunicationCategory (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-version-code |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
category:typeCode | 1..1 | CodeableConcept | Use value set "Correspondance type code" Binding: CommunicationCategory (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-type-code |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
category:statusCode | 1..1 | CodeableConcept | Use value set "Correspondance status code" Binding: CommunicationCategory (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-status-code |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
medium | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example) | |
subject | Σ | 1..1 | Reference(Patient | Group) {r} | Focus of message |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-correspondance-address | 0..1 | (Complex) | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-correspondance-address | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
display | Σ | 0..1 | string | Text alternative for the resource |
recipient | 1..1 | Reference(Organization | Patient | Practitioner) {r} | Message recipient | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
display | Σ | 1..1 | string | Text alternative for the resource |
topic | 0..* | Reference(Resource) {r} | Focal resources | |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) {r} | Encounter or episode leading to message |
sent | 1..1 | dateTime | When sent | |
received | 0..1 | dateTime | When received | |
sender | 1..1 | Reference(Organization | Patient | Practitioner) {r} | Message sender | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
display | Σ | 1..1 | string | Text alternative for the resource |
reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMED CT Clinical Findings (example) |
reasonReference | Σ | 0..* | Reference(Condition | Observation) {r} | Why was communication done? |
payload | I | 1..* | BackboneElement | Message payload |
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 |
content[x] | 1..1 | (Slice Definition) | Message part content Slice: Unordered, Closed by type:$this | |
content[x]:contentAttachment | 1..1 | Attachment | Message part content | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-referencetype | 0..1 | string | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referencetype | |
ehealth-reference-description | 0..1 | string | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reference-description | |
ehealth-identifier | 0..1 | Identifier | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-identifier | |
contentType | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: mimetypes (required) Example General: text/plain; charset=UTF-8, image/png |
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: Common Languages (extensible) Max Binding: All Languages Example General: en-AU |
data | 0..1 | base64Binary | Data inline, base64ed | |
url | Σ | 0..1 | uri | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
creation | Σ | 0..1 | dateTime | Date attachment was first created |
note | 0..* | Annotation | Comments made about the communication | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
author[x] | Σ | 0..1 | Individual responsible for the annotation | |
authorReference | Reference(Practitioner | Patient | RelatedPerson) | |||
authorString | string | |||
time | Σ | 0..1 | dateTime | When the annotation was made |
text | 1..1 | string | The annotation - text content | |
Documentation for this format |
This structure is derived from Communication
Summary
Mandatory: 17 elements
Fixed Value: 6 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-authorizationTime | 1..1 | dateTime | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime | |
identifier | 1..* | (Slice Definition) | Unique identifier Slice: Unordered, Open by value:system | |
identifier:envelopeIdentifier | 1..1 | Identifier | Use value set "CorrespondanceEnvelopeIdentifier" | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ehealth.sundhed.dk/correspondance-envelope-identifier | |
identifier:letterIdentifier | 1..1 | Identifier | Use value set "CorrespondanceEnvelopeIdentifier" | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ehealth.sundhed.dk/correspondance-letter-identifier | |
definition | 0..* | Reference(PlanDefinition | ActivityDefinition) {r} | Instantiates protocol or definition | |
basedOn | 0..* | Reference(Resource) {r} | Request fulfilled by this communication | |
partOf | 0..* | Reference(Resource) {r} | Part of this action | |
category | 0..* | (Slice Definition) | Message category Slice: Unordered, Open by value:coding.system | |
category:acknowledgementCode | 1..1 | CodeableConcept | Use value set "Correspondance acknowledgement code" | |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-acknowledgement-code | |
category:versionCode | 1..1 | CodeableConcept | Use value set "Correspondance version code" | |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-version-code | |
category:typeCode | 1..1 | CodeableConcept | Use value set "Correspondance type code" | |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-type-code | |
category:statusCode | 1..1 | CodeableConcept | Use value set "Correspondance status code" | |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-status-code | |
subject | 1..1 | Reference(Patient | Group) {r} | Focus of message | |
identifier | 0..1 | Identifier | Logical reference, when literal reference is not known | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-correspondance-address | 0..1 | (Complex) | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-correspondance-address | |
recipient | 1..1 | Reference(Organization | Patient | Practitioner) {r} | Message recipient | |
display | 1..1 | string | Text alternative for the resource | |
topic | 0..* | Reference(Resource) {r} | Focal resources | |
context | 0..1 | Reference(Encounter | EpisodeOfCare) {r} | Encounter or episode leading to message | |
sent | 1..1 | dateTime | When sent | |
sender | 1..1 | Reference(Organization | Patient | Practitioner) {r} | Message sender | |
display | 1..1 | string | Text alternative for the resource | |
reasonReference | 0..* | Reference(Condition | Observation) {r} | Why was communication done? | |
payload | 1..* | BackboneElement | Message payload | |
contentAttachment:contentAttachment | 1..1 | Attachment | Message part content | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-referencetype | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referencetype | |
ehealth-reference-description | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reference-description | |
ehealth-identifier | 0..1 | Identifier | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-identifier | |
note | ||||
author[x] | 0..1 | Individual responsible for the annotation | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson) | |||
authorString | string | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | I | 0..* | Communication | A record of information transmitted from a sender to a receiver |
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) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-authorizationTime | I | 1..1 | dateTime | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | (Slice Definition) | Unique identifier Slice: Unordered, Open by value:system |
identifier:envelopeIdentifier | Σ | 1..1 | Identifier | Use value set "CorrespondanceEnvelopeIdentifier" |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ehealth.sundhed.dk/correspondance-envelope-identifier |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
identifier:letterIdentifier | Σ | 1..1 | Identifier | Use value set "CorrespondanceEnvelopeIdentifier" |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ehealth.sundhed.dk/correspondance-letter-identifier |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
definition | Σ | 0..* | Reference(PlanDefinition | ActivityDefinition) {r} | Instantiates protocol or definition |
basedOn | Σ | 0..* | Reference(Resource) {r} | Request fulfilled by this communication |
partOf | Σ | 0..* | Reference(Resource) {r} | Part of this action |
status | ?!Σ | 1..1 | code | preparation | in-progress | suspended | aborted | completed | entered-in-error Binding: EventStatus (required) |
notDone | ?!Σ | 0..1 | boolean | Communication did not occur |
notDoneReason | ΣI | 0..1 | CodeableConcept | Why communication did not occur Binding: CommunicationNotDoneReason (example) |
category | 0..* | (Slice Definition) | Message category Slice: Unordered, Open by value:coding.system Binding: CommunicationCategory (example) | |
category:acknowledgementCode | 1..1 | CodeableConcept | Use value set "Correspondance acknowledgement code" Binding: CommunicationCategory (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-acknowledgement-code |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
category:versionCode | 1..1 | CodeableConcept | Use value set "Correspondance version code" Binding: CommunicationCategory (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-version-code |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
category:typeCode | 1..1 | CodeableConcept | Use value set "Correspondance type code" Binding: CommunicationCategory (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-type-code |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
category:statusCode | 1..1 | CodeableConcept | Use value set "Correspondance status code" Binding: CommunicationCategory (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://ehealth.sundhed.dk/correspondance-status-code |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
medium | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example) | |
subject | Σ | 1..1 | Reference(Patient | Group) {r} | Focus of message |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-correspondance-address | 0..1 | (Complex) | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-correspondance-address | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
display | Σ | 0..1 | string | Text alternative for the resource |
recipient | 1..1 | Reference(Organization | Patient | Practitioner) {r} | Message recipient | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
display | Σ | 1..1 | string | Text alternative for the resource |
topic | 0..* | Reference(Resource) {r} | Focal resources | |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) {r} | Encounter or episode leading to message |
sent | 1..1 | dateTime | When sent | |
received | 0..1 | dateTime | When received | |
sender | 1..1 | Reference(Organization | Patient | Practitioner) {r} | Message sender | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
display | Σ | 1..1 | string | Text alternative for the resource |
reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMED CT Clinical Findings (example) |
reasonReference | Σ | 0..* | Reference(Condition | Observation) {r} | Why was communication done? |
payload | I | 1..* | BackboneElement | Message payload |
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 |
content[x] | 1..1 | (Slice Definition) | Message part content Slice: Unordered, Closed by type:$this | |
content[x]:contentAttachment | 1..1 | Attachment | Message part content | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-referencetype | 0..1 | string | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referencetype | |
ehealth-reference-description | 0..1 | string | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reference-description | |
ehealth-identifier | 0..1 | Identifier | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-identifier | |
contentType | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: mimetypes (required) Example General: text/plain; charset=UTF-8, image/png |
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: Common Languages (extensible) Max Binding: All Languages Example General: en-AU |
data | 0..1 | base64Binary | Data inline, base64ed | |
url | Σ | 0..1 | uri | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
creation | Σ | 0..1 | dateTime | Date attachment was first created |
note | 0..* | Annotation | Comments made about the communication | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
author[x] | Σ | 0..1 | Individual responsible for the annotation | |
authorReference | Reference(Practitioner | Patient | RelatedPerson) | |||
authorString | string | |||
time | Σ | 0..1 | dateTime | When the annotation was made |
text | 1..1 | string | The annotation - text content | |
Documentation for this format |
Path | Conformance | ValueSet |
Communication.language | extensible | Common Languages Max Binding: All Languages |
Communication.identifier:envelopeIdentifier.use | required | IdentifierUse |
Communication.identifier:envelopeIdentifier.type | extensible | Identifier Type Codes |
Communication.identifier:letterIdentifier.use | required | IdentifierUse |
Communication.identifier:letterIdentifier.type | extensible | Identifier Type Codes |
Communication.status | required | EventStatus |
Communication.notDoneReason | example | CommunicationNotDoneReason |
Communication.category | example | CommunicationCategory |
Communication.category:acknowledgementCode | example | CommunicationCategory |
Communication.category:versionCode | example | CommunicationCategory |
Communication.category:typeCode | example | CommunicationCategory |
Communication.category:statusCode | example | CommunicationCategory |
Communication.medium | example | v3 Code System ParticipationMode |
Communication.subject.identifier.use | required | IdentifierUse |
Communication.subject.identifier.type | extensible | Identifier Type Codes |
Communication.reasonCode | example | SNOMED CT Clinical Findings |
Communication.payload.content[x]:contentAttachment.contentType | required | http://hl7.org/fhir/ValueSet/mimetypes |
Communication.payload.content[x]:contentAttachment.language | extensible | Common Languages Max Binding: All Languages |
Id | Path | Details | Requirements |
dom-2 | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | Communication | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | Communication | 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 | Communication | 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() | |
com-1 | Communication | Not Done Reason can only be specified if NotDone is "true" : notDone or notDoneReason.exists().not() | |
ele-1 | Communication.extension:authorizationTime | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Communication.extension:authorizationTime | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |