eHealth Infrastructure (v2020.8)

StructureDefinition: ehealth-correspondance

Formal Views of Profile Content

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:

  • clinicalinformation: For the most usual case: clinical information about the subject (base64-encoded in the data section)
  • url: For references to external URLs
  • sup: To specify if additional data exists in the SUP database
  • attachment: For binary attachments, eg. images, PDF documents etc. These are included base64-encoded in the data section)

For remaining document data, see the corresponding value sets.

This profile builds on Communication.

This profile was published on Thu Jan 07 13:26:31 UTC 2021 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:

  • The element Communication.identifier is sliced based on the value of value:system
  • The element Communication.category is sliced based on the value of value:coding.system

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-authorizationTime 1..1dateTimeExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime
... identifier 1..*(Slice Definition)Unique identifier
Slice: Unordered, Open by value:system
.... identifier:envelopeIdentifier 1..1IdentifierUse value set "CorrespondanceEnvelopeIdentifier"
..... system 1..1uriThe namespace for the identifier value
Fixed Value: http://ehealth.sundhed.dk/correspondance-envelope-identifier
.... identifier:letterIdentifier 1..1IdentifierUse value set "CorrespondanceEnvelopeIdentifier"
..... system 1..1uriThe 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..1CodeableConceptUse value set "Correspondance acknowledgement code"
..... coding 0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-acknowledgement-code
.... category:versionCode 1..1CodeableConceptUse value set "Correspondance version code"
..... coding 0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-version-code
.... category:typeCode 1..1CodeableConceptUse value set "Correspondance type code"
..... coding 0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-type-code
.... category:statusCode 1..1CodeableConceptUse value set "Correspondance status code"
..... coding 0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-status-code
... subject 1..1Reference(Patient | Group) {r}Focus of message
.... identifier 0..1IdentifierLogical reference, when literal reference is not known
..... extension 0..*ExtensionExtension
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..1Reference(Organization | Patient | Practitioner) {r}Message recipient
.... display 1..1stringText alternative for the resource
... topic 0..*Reference(Resource) {r}Focal resources
... context 0..1Reference(Encounter | EpisodeOfCare) {r}Encounter or episode leading to message
... sent 1..1dateTimeWhen sent
... sender 1..1Reference(Organization | Patient | Practitioner) {r}Message sender
.... display 1..1stringText alternative for the resource
... reasonReference 0..*Reference(Condition | Observation) {r}Why was communication done?
... payload 1..*BackboneElementMessage payload
.... contentAttachment:contentAttachment 1..1AttachmentMessage part content
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ehealth-referencetype 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referencetype
..... ehealth-reference-description 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reference-description
..... ehealth-identifier 0..1IdentifierExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-identifier
... note
.... author[x] 0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson)
..... authorStringstring

doco Documentation for this format

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*CommunicationA record of information transmitted from a sender to a receiver
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-authorizationTime 1..1dateTimeOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*(Slice Definition)Unique identifier
Slice: Unordered, Open by value:system
.... identifier:envelopeIdentifier Σ1..1IdentifierUse value set "CorrespondanceEnvelopeIdentifier"
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ehealth.sundhed.dk/correspondance-envelope-identifier
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:letterIdentifier Σ1..1IdentifierUse value set "CorrespondanceEnvelopeIdentifier"
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ehealth.sundhed.dk/correspondance-letter-identifier
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(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..1codepreparation | in-progress | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required): The status of the communication.

... notDone ?!Σ0..1booleanCommunication did not occur
... notDoneReason ΣI0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication was not done.

... category 0..*(Slice Definition)Message category
Slice: Unordered, Open by value:coding.system
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


.... category:acknowledgementCode 1..1CodeableConceptUse value set "Correspondance acknowledgement code"
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-acknowledgement-code
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... category:versionCode 1..1CodeableConceptUse value set "Correspondance version code"
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-version-code
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... category:typeCode 1..1CodeableConceptUse value set "Correspondance type code"
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-type-code
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... category:statusCode 1..1CodeableConceptUse value set "Correspondance status code"
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-status-code
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... medium 0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... subject Σ1..1Reference(Patient | Group) {r}Focus of message
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
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..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... display Σ0..1stringText alternative for the resource
... recipient 1..1Reference(Organization | Patient | Practitioner) {r}Message recipient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ1..1stringText alternative for the resource
... topic 0..*Reference(Resource) {r}Focal resources
... context Σ0..1Reference(Encounter | EpisodeOfCare) {r}Encounter or episode leading to message
... sent 1..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... sender 1..1Reference(Organization | Patient | Practitioner) {r}Message sender
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ1..1stringText alternative for the resource
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMED CT Clinical Findings (example): Codes for describing reasons for the occurrence of a communication.


... reasonReference Σ0..*Reference(Condition | Observation) {r}Why was communication done?
... payload 1..*BackboneElementMessage payload
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1(Slice Definition)Message part content
Slice: Unordered, Closed by type:$this
..... content[x]:contentAttachment 1..1AttachmentMessage part content
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... ehealth-referencetype 0..1stringOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referencetype
...... ehealth-reference-description 0..1stringOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reference-description
...... ehealth-identifier 0..1IdentifierOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-identifier
...... contentType Σ0..1codeMime type of the content, with charset etc.
Binding: mimetypes (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
...... language Σ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible)
Max Binding: All Languages: A human language.


Example General: en-AU
...... data 0..1base64BinaryData inline, base64ed
...... url Σ0..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
...... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
...... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
...... creation Σ0..1dateTimeDate attachment was first created
... note 0..*AnnotationComments made about the communication
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content

doco 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:

  • The element Communication.identifier is sliced based on the value of value:system
  • The element Communication.category is sliced based on the value of value:coding.system

Differential View

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-authorizationTime 1..1dateTimeExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime
... identifier 1..*(Slice Definition)Unique identifier
Slice: Unordered, Open by value:system
.... identifier:envelopeIdentifier 1..1IdentifierUse value set "CorrespondanceEnvelopeIdentifier"
..... system 1..1uriThe namespace for the identifier value
Fixed Value: http://ehealth.sundhed.dk/correspondance-envelope-identifier
.... identifier:letterIdentifier 1..1IdentifierUse value set "CorrespondanceEnvelopeIdentifier"
..... system 1..1uriThe 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..1CodeableConceptUse value set "Correspondance acknowledgement code"
..... coding 0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-acknowledgement-code
.... category:versionCode 1..1CodeableConceptUse value set "Correspondance version code"
..... coding 0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-version-code
.... category:typeCode 1..1CodeableConceptUse value set "Correspondance type code"
..... coding 0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-type-code
.... category:statusCode 1..1CodeableConceptUse value set "Correspondance status code"
..... coding 0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-status-code
... subject 1..1Reference(Patient | Group) {r}Focus of message
.... identifier 0..1IdentifierLogical reference, when literal reference is not known
..... extension 0..*ExtensionExtension
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..1Reference(Organization | Patient | Practitioner) {r}Message recipient
.... display 1..1stringText alternative for the resource
... topic 0..*Reference(Resource) {r}Focal resources
... context 0..1Reference(Encounter | EpisodeOfCare) {r}Encounter or episode leading to message
... sent 1..1dateTimeWhen sent
... sender 1..1Reference(Organization | Patient | Practitioner) {r}Message sender
.... display 1..1stringText alternative for the resource
... reasonReference 0..*Reference(Condition | Observation) {r}Why was communication done?
... payload 1..*BackboneElementMessage payload
.... contentAttachment:contentAttachment 1..1AttachmentMessage part content
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ehealth-referencetype 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referencetype
..... ehealth-reference-description 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reference-description
..... ehealth-identifier 0..1IdentifierExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-identifier
... note
.... author[x] 0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson)
..... authorStringstring

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*CommunicationA record of information transmitted from a sender to a receiver
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-authorizationTime 1..1dateTimeOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*(Slice Definition)Unique identifier
Slice: Unordered, Open by value:system
.... identifier:envelopeIdentifier Σ1..1IdentifierUse value set "CorrespondanceEnvelopeIdentifier"
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ehealth.sundhed.dk/correspondance-envelope-identifier
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:letterIdentifier Σ1..1IdentifierUse value set "CorrespondanceEnvelopeIdentifier"
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ehealth.sundhed.dk/correspondance-letter-identifier
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(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..1codepreparation | in-progress | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required): The status of the communication.

... notDone ?!Σ0..1booleanCommunication did not occur
... notDoneReason ΣI0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication was not done.

... category 0..*(Slice Definition)Message category
Slice: Unordered, Open by value:coding.system
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


.... category:acknowledgementCode 1..1CodeableConceptUse value set "Correspondance acknowledgement code"
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-acknowledgement-code
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... category:versionCode 1..1CodeableConceptUse value set "Correspondance version code"
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-version-code
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... category:typeCode 1..1CodeableConceptUse value set "Correspondance type code"
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-type-code
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... category:statusCode 1..1CodeableConceptUse value set "Correspondance status code"
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/correspondance-status-code
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... medium 0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... subject Σ1..1Reference(Patient | Group) {r}Focus of message
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
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..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... display Σ0..1stringText alternative for the resource
... recipient 1..1Reference(Organization | Patient | Practitioner) {r}Message recipient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ1..1stringText alternative for the resource
... topic 0..*Reference(Resource) {r}Focal resources
... context Σ0..1Reference(Encounter | EpisodeOfCare) {r}Encounter or episode leading to message
... sent 1..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... sender 1..1Reference(Organization | Patient | Practitioner) {r}Message sender
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ1..1stringText alternative for the resource
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMED CT Clinical Findings (example): Codes for describing reasons for the occurrence of a communication.


... reasonReference Σ0..*Reference(Condition | Observation) {r}Why was communication done?
... payload 1..*BackboneElementMessage payload
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1(Slice Definition)Message part content
Slice: Unordered, Closed by type:$this
..... content[x]:contentAttachment 1..1AttachmentMessage part content
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... ehealth-referencetype 0..1stringOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referencetype
...... ehealth-reference-description 0..1stringOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reference-description
...... ehealth-identifier 0..1IdentifierOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-identifier
...... contentType Σ0..1codeMime type of the content, with charset etc.
Binding: mimetypes (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
...... language Σ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible)
Max Binding: All Languages: A human language.


Example General: en-AU
...... data 0..1base64BinaryData inline, base64ed
...... url Σ0..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
...... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
...... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
...... creation Σ0..1dateTimeDate attachment was first created
... note 0..*AnnotationComments made about the communication
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content

doco Documentation for this format

 

Terminology Bindings

PathConformanceValueSet
Communication.languageextensibleCommon Languages
Max Binding: All Languages
Communication.identifier:envelopeIdentifier.userequiredIdentifierUse
Communication.identifier:envelopeIdentifier.typeextensibleIdentifier Type Codes
Communication.identifier:letterIdentifier.userequiredIdentifierUse
Communication.identifier:letterIdentifier.typeextensibleIdentifier Type Codes
Communication.statusrequiredEventStatus
Communication.notDoneReasonexampleCommunicationNotDoneReason
Communication.categoryexampleCommunicationCategory
Communication.category:acknowledgementCodeexampleCommunicationCategory
Communication.category:versionCodeexampleCommunicationCategory
Communication.category:typeCodeexampleCommunicationCategory
Communication.category:statusCodeexampleCommunicationCategory
Communication.mediumexamplev3 Code System ParticipationMode
Communication.subject.identifier.userequiredIdentifierUse
Communication.subject.identifier.typeextensibleIdentifier Type Codes
Communication.reasonCodeexampleSNOMED CT Clinical Findings
Communication.payload.content[x]:contentAttachment.contentTyperequiredhttp://hl7.org/fhir/ValueSet/mimetypes
Communication.payload.content[x]:contentAttachment.languageextensibleCommon Languages
Max Binding: All Languages

Constraints

IdPathDetailsRequirements
dom-2CommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1CommunicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4CommunicationIf 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-3CommunicationIf 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-1CommunicationNot Done Reason can only be specified if NotDone is "true"
: notDone or notDoneReason.exists().not()
ele-1Communication.extension:authorizationTimeAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Communication.extension:authorizationTimeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.payloadAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
.