eHealth Infrastructure (v2019.5.1)

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 May 16 12:32:10 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:

  • 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..*
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... ehealth-authorizationTime 1..1dateTimeOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime
... identifier IdentifierSlice: Unordered, Open by value:system
... identifier 1..1IdentifierUse value set "CorrespondanceEnvelopeIdentifier"
.... system 1..1uriFixed Value: http://ehealth.sundhed.dk/correspondance-envelope-identifier
... identifier 1..1IdentifierUse value set "CorrespondanceEnvelopeIdentifier"
.... system 1..1uriFixed Value: http://ehealth.sundhed.dk/correspondance-letter-identifier
... definition 0..*Reference(PlanDefinition | ActivityDefinition) {r}
... basedOn 0..*Reference(Resource) {r}
... partOf 0..*Reference(Resource) {r}
... category CodeableConceptSlice: Unordered, Open by value:coding.system
... category 1..1CodeableConceptUse value set "Correspondance acknowledgement code"
.... coding 0..*Coding
..... system 0..1uriFixed Value: http://ehealth.sundhed.dk/correspondance-acknowledgement-code
... category 1..1CodeableConceptUse value set "Correspondance version code"
.... coding 0..*Coding
..... system 0..1uriFixed Value: http://ehealth.sundhed.dk/correspondance-version-code
... category 1..1CodeableConceptUse value set "Correspondance type code"
.... coding 0..*Coding
..... system 0..1uriFixed Value: http://ehealth.sundhed.dk/correspondance-type-code
... category 1..1CodeableConceptUse value set "Correspondance status code"
.... coding 0..*Coding
..... system 0..1uriFixed Value: http://ehealth.sundhed.dk/correspondance-status-code
... subject 1..1Reference(Patient | Group) {r}
.... identifier 0..1Identifier
..... extension 0..*ExtensionSlice: 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}
.... display 1..1string
... topic 0..*Reference(Resource) {r}
... context 0..1Reference(Encounter | EpisodeOfCare) {r}
... sent 1..1dateTime
... sender 1..1Reference(Organization | Patient | Practitioner) {r}
.... display 1..1string
... reasonReference 0..*Reference(Condition | Observation) {r}
... payload 1..*BackboneElement
.... contentAttachment 1..1Attachment
..... extension 0..*ExtensionSlice: 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

doco Documentation for this format

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*A 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)
... text I0..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..1dateTimeExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierUnique identifier
Slice: Unordered, Open by value:system
... identifier Σ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)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... 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 Σ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)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... 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)
... notDone ?!Σ0..1booleanCommunication did not occur
... notDoneReason ΣI0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example)
... category CodeableConceptMessage category
Slice: Unordered, Open by value:coding.system
Binding: CommunicationCategory (example)
... category 1..1CodeableConceptUse value set "Correspondance acknowledgement code"
Binding: CommunicationCategory (example)
.... 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 1..1CodeableConceptUse value set "Correspondance version code"
Binding: CommunicationCategory (example)
.... 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 1..1CodeableConceptUse value set "Correspondance type code"
Binding: CommunicationCategory (example)
.... 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 1..1CodeableConceptUse value set "Correspondance status code"
Binding: CommunicationCategory (example)
.... 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)
... 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)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-correspondance-address
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1base64Binary, 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, MetaValue of extension
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ0..1uriThe 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..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)
... reasonReference Σ0..*Reference(Condition | Observation) {r}Why was communication done?
... payload I1..*BackboneElementMessage payload
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referencetype
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1base64Binary, 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, MetaValue of extension
..... ehealth-reference-description 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reference-description
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1base64Binary, 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, MetaValue of extension
..... ehealth-identifier 0..1IdentifierExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-identifier
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1base64Binary, 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, MetaValue of extension
..... contentType Σ0..1codeMime type of the content, with charset etc.
Binding: mimetypes (required)
Example General': text/plain; charset=UTF-8, image/png
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible)
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..1Reference(Practitioner | Patient | RelatedPerson) {r}, stringIndividual responsible for the annotation
.... 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..*
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... ehealth-authorizationTime 1..1dateTimeOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime
... identifier IdentifierSlice: Unordered, Open by value:system
... identifier 1..1IdentifierUse value set "CorrespondanceEnvelopeIdentifier"
.... system 1..1uriFixed Value: http://ehealth.sundhed.dk/correspondance-envelope-identifier
... identifier 1..1IdentifierUse value set "CorrespondanceEnvelopeIdentifier"
.... system 1..1uriFixed Value: http://ehealth.sundhed.dk/correspondance-letter-identifier
... definition 0..*Reference(PlanDefinition | ActivityDefinition) {r}
... basedOn 0..*Reference(Resource) {r}
... partOf 0..*Reference(Resource) {r}
... category CodeableConceptSlice: Unordered, Open by value:coding.system
... category 1..1CodeableConceptUse value set "Correspondance acknowledgement code"
.... coding 0..*Coding
..... system 0..1uriFixed Value: http://ehealth.sundhed.dk/correspondance-acknowledgement-code
... category 1..1CodeableConceptUse value set "Correspondance version code"
.... coding 0..*Coding
..... system 0..1uriFixed Value: http://ehealth.sundhed.dk/correspondance-version-code
... category 1..1CodeableConceptUse value set "Correspondance type code"
.... coding 0..*Coding
..... system 0..1uriFixed Value: http://ehealth.sundhed.dk/correspondance-type-code
... category 1..1CodeableConceptUse value set "Correspondance status code"
.... coding 0..*Coding
..... system 0..1uriFixed Value: http://ehealth.sundhed.dk/correspondance-status-code
... subject 1..1Reference(Patient | Group) {r}
.... identifier 0..1Identifier
..... extension 0..*ExtensionSlice: 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}
.... display 1..1string
... topic 0..*Reference(Resource) {r}
... context 0..1Reference(Encounter | EpisodeOfCare) {r}
... sent 1..1dateTime
... sender 1..1Reference(Organization | Patient | Practitioner) {r}
.... display 1..1string
... reasonReference 0..*Reference(Condition | Observation) {r}
... payload 1..*BackboneElement
.... contentAttachment 1..1Attachment
..... extension 0..*ExtensionSlice: 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*A 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)
... text I0..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..1dateTimeExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-authorizationTime
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierUnique identifier
Slice: Unordered, Open by value:system
... identifier Σ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)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... 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 Σ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)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... 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)
... notDone ?!Σ0..1booleanCommunication did not occur
... notDoneReason ΣI0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example)
... category CodeableConceptMessage category
Slice: Unordered, Open by value:coding.system
Binding: CommunicationCategory (example)
... category 1..1CodeableConceptUse value set "Correspondance acknowledgement code"
Binding: CommunicationCategory (example)
.... 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 1..1CodeableConceptUse value set "Correspondance version code"
Binding: CommunicationCategory (example)
.... 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 1..1CodeableConceptUse value set "Correspondance type code"
Binding: CommunicationCategory (example)
.... 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 1..1CodeableConceptUse value set "Correspondance status code"
Binding: CommunicationCategory (example)
.... 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)
... 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)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-correspondance-address
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1base64Binary, 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, MetaValue of extension
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ0..1uriThe 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..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)
... reasonReference Σ0..*Reference(Condition | Observation) {r}Why was communication done?
... payload I1..*BackboneElementMessage payload
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referencetype
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1base64Binary, 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, MetaValue of extension
..... ehealth-reference-description 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reference-description
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1base64Binary, 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, MetaValue of extension
..... ehealth-identifier 0..1IdentifierExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-identifier
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1base64Binary, 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, MetaValue of extension
..... contentType Σ0..1codeMime type of the content, with charset etc.
Binding: mimetypes (required)
Example General': text/plain; charset=UTF-8, image/png
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible)
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..1Reference(Practitioner | Patient | RelatedPerson) {r}, stringIndividual responsible for the annotation
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content

doco Documentation for this format

 

Terminology Bindings

PathNameConformanceValueSet
Communication.languageCommon LanguagesextensibleCommon Languages
Communication.identifier.useIdentifierUserequiredIdentifierUse
Communication.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Communication.identifier.useIdentifierUserequiredIdentifierUse
Communication.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Communication.statusEventStatusrequiredEventStatus
Communication.notDoneReasonCommunicationNotDoneReasonexampleCommunicationNotDoneReason
Communication.categoryCommunicationCategoryexampleCommunicationCategory
Communication.categoryCommunicationCategoryexampleCommunicationCategory
Communication.categoryCommunicationCategoryexampleCommunicationCategory
Communication.categoryCommunicationCategoryexampleCommunicationCategory
Communication.categoryCommunicationCategoryexampleCommunicationCategory
Communication.mediumv3 Code System ParticipationModeexamplev3 Code System ParticipationMode
Communication.subject.identifier.useIdentifierUserequiredIdentifierUse
Communication.subject.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Communication.reasonCodeSNOMED CT Clinical FindingsexampleSNOMED CT Clinical Findings
Communication.payload.contentAttachment.contentType?extrequiredhttp://hl7.org/fhir/ValueSet/mimetypes
Communication.payload.contentAttachment.languageCommon LanguagesextensibleCommon 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.payloadAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
.