eHealth Infrastructure (v1.0.0)
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 Wed Mar 06 14:43:56 UTC 2019 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..* | |||
  extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
| ehealth-authorizationTime | 1..1 | dateTime | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime | |
 identifier | Identifier | Slice: Unordered, Open by value:system | ||
| identifier | 1..1 | Identifier | Use value set "CorrespondanceEnvelopeIdentifier" | |
  system | 1..1 | uri | Fixed Value: http://ehealth.sundhed.dk/correspondance-envelope-identifier | |
| identifier | 1..1 | Identifier | Use value set "CorrespondanceEnvelopeIdentifier" | |
| system | 1..1 | uri | Fixed Value: http://ehealth.sundhed.dk/correspondance-letter-identifier | |
| category | CodeableConcept | Slice: Unordered, Open by value:coding.system | ||
| category | 1..1 | CodeableConcept | Use value set "Correspondance acknowledgement code" | |
| coding | 0..* | Coding | ||
  system | 0..1 | uri | Fixed Value: http://ehealth.sundhed.dk/correspondance-acknowledgement-code | |
| category | 1..1 | CodeableConcept | Use value set "Correspondance version code" | |
| coding | 0..* | Coding | ||
| system | 0..1 | uri | Fixed Value: http://ehealth.sundhed.dk/correspondance-version-code | |
| category | 1..1 | CodeableConcept | Use value set "Correspondance type code" | |
| coding | 0..* | Coding | ||
| system | 0..1 | uri | Fixed Value: http://ehealth.sundhed.dk/correspondance-type-code | |
| category | 1..1 | CodeableConcept | Use value set "Correspondance status code" | |
| coding | 0..* | Coding | ||
| system | 0..1 | uri | Fixed Value: http://ehealth.sundhed.dk/correspondance-status-code | |
| subject | 1..1 | Reference(Patient | Group) | ||
| identifier | 0..1 | Identifier | ||
| extension | 0..* | 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) | ||
| display | 1..1 | string | ||
| sent | 1..1 | dateTime | ||
| sender | 1..1 | Reference(Organization | Patient | Practitioner) | ||
| display | 1..1 | string | ||
| payload | 1..* | BackboneElement | ||
 contentAttachment | 1..1 | Attachment | ||
 extension | 0..* | 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 | |
| Documentation for this format | ||||
This structure is derived from Communication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication | I | 0..* | 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) | |
| 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 | 1..1 | dateTime | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | Identifier | Unique identifier Slice: Unordered, Open by value:system | |
| identifier | Σ | 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 | Σ | 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) | Instantiates protocol or definition |
| basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this communication |
| partOf | Σ | 0..* | Reference(Resource) | 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 | CodeableConcept | Message category Slice: Unordered, Open by value:coding.system Binding: CommunicationCategory (example) | ||
| category | 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 | 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 | 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 | 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) | 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) | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-correspondance-address | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | identifies the meaning of the extension | |
 value[x] | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Value of extension | |
| 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 or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
| 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) | 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) | Focal resources | |
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | 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) | 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) | 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 |
| 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 | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referencetype | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | identifies the meaning of the extension | |
| value[x] | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Value of extension | |
| ehealth-reference-description | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reference-description | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | identifies the meaning of the extension | |
| value[x] | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Value of extension | |
| ehealth-identifier | 0..1 | Identifier | Extension 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) 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 | |
| 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..* | |||
| extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
| ehealth-authorizationTime | 1..1 | dateTime | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime | |
| identifier | Identifier | Slice: Unordered, Open by value:system | ||
| identifier | 1..1 | Identifier | Use value set "CorrespondanceEnvelopeIdentifier" | |
| system | 1..1 | uri | Fixed Value: http://ehealth.sundhed.dk/correspondance-envelope-identifier | |
| identifier | 1..1 | Identifier | Use value set "CorrespondanceEnvelopeIdentifier" | |
| system | 1..1 | uri | Fixed Value: http://ehealth.sundhed.dk/correspondance-letter-identifier | |
| category | CodeableConcept | Slice: Unordered, Open by value:coding.system | ||
| category | 1..1 | CodeableConcept | Use value set "Correspondance acknowledgement code" | |
| coding | 0..* | Coding | ||
| system | 0..1 | uri | Fixed Value: http://ehealth.sundhed.dk/correspondance-acknowledgement-code | |
| category | 1..1 | CodeableConcept | Use value set "Correspondance version code" | |
| coding | 0..* | Coding | ||
| system | 0..1 | uri | Fixed Value: http://ehealth.sundhed.dk/correspondance-version-code | |
| category | 1..1 | CodeableConcept | Use value set "Correspondance type code" | |
| coding | 0..* | Coding | ||
| system | 0..1 | uri | Fixed Value: http://ehealth.sundhed.dk/correspondance-type-code | |
| category | 1..1 | CodeableConcept | Use value set "Correspondance status code" | |
| coding | 0..* | Coding | ||
| system | 0..1 | uri | Fixed Value: http://ehealth.sundhed.dk/correspondance-status-code | |
| subject | 1..1 | Reference(Patient | Group) | ||
| identifier | 0..1 | Identifier | ||
| extension | 0..* | 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) | ||
| display | 1..1 | string | ||
| sent | 1..1 | dateTime | ||
| sender | 1..1 | Reference(Organization | Patient | Practitioner) | ||
| display | 1..1 | string | ||
| payload | 1..* | BackboneElement | ||
| contentAttachment | 1..1 | Attachment | ||
| extension | 0..* | 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 | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication | I | 0..* | 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) | |
| 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 | 1..1 | dateTime | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | Identifier | Unique identifier Slice: Unordered, Open by value:system | |
| identifier | Σ | 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 | Σ | 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) | Instantiates protocol or definition |
| basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this communication |
| partOf | Σ | 0..* | Reference(Resource) | 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 | CodeableConcept | Message category Slice: Unordered, Open by value:coding.system Binding: CommunicationCategory (example) | ||
| category | 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 | 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 | 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 | 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) | 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) | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-correspondance-address | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | identifies the meaning of the extension | |
| value[x] | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Value of extension | |
| 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 or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
| 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) | 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) | Focal resources | |
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | 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) | 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) | 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 |
| 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 | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referencetype | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | identifies the meaning of the extension | |
| value[x] | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Value of extension | |
| ehealth-reference-description | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reference-description | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | identifies the meaning of the extension | |
| value[x] | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Value of extension | |
| ehealth-identifier | 0..1 | Identifier | Extension 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) 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 | |
| Documentation for this format | ||||
| Path | Name | Conformance | ValueSet |
| Communication.language | Common Languages | extensible | Common Languages |
| Communication.identifier.use | IdentifierUse | required | IdentifierUse |
| Communication.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
| Communication.identifier.use | IdentifierUse | required | IdentifierUse |
| Communication.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
| Communication.status | EventStatus | required | EventStatus |
| Communication.notDoneReason | CommunicationNotDoneReason | example | CommunicationNotDoneReason |
| Communication.category | CommunicationCategory | example | CommunicationCategory |
| Communication.category | CommunicationCategory | example | CommunicationCategory |
| Communication.category | CommunicationCategory | example | CommunicationCategory |
| Communication.category | CommunicationCategory | example | CommunicationCategory |
| Communication.category | CommunicationCategory | example | CommunicationCategory |
| Communication.medium | v3 Code System ParticipationMode | example | v3 Code System ParticipationMode |
| Communication.subject.identifier.use | IdentifierUse | required | IdentifierUse |
| Communication.subject.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
| Communication.reasonCode | SNOMED CT Clinical Findings | example | SNOMED CT Clinical Findings |
| Communication.payload.contentAttachment.contentType | ?ext | required | http://hl7.org/fhir/ValueSet/mimetypes |
| Communication.payload.contentAttachment.language | Common Languages | extensible | Common 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.payload | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |