This page is part of the CH-CRL (R4) (v0.1.0: STU Draft). This is the current published version. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://fhir.ch/ig/ch-crl/StructureDefinition/ch-crl-communication
Profile on Communication for Reporting to the Cancer Registry
This profile builds on Communication.
This profile was published on Mon Sep 02 00:00:00 CEST 2019 as a draft by Bundesamt für Gesundheit BAG.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Communication
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | 0..* | |||
subject | 1..1 | Reference(CH CRL Patient Profile) | Patient | |
reference | 1..1 | string | ||
topic | 1..1 | CodeableConcept | Date of informing the patient | |
coding | 1..1 | Coding | ||
display | 1..1 | string | Date (YYYY-MM-DD) | |
sent | 1..1 | dateTime | ||
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 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Unique identifier |
instantiatesCanonical | ΣI | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition |
instantiatesUri | ΣI | 0..* | uri | Instantiates external protocol or definition |
basedOn | ΣI | 0..* | Reference(Resource) | Request fulfilled by this communication |
partOf | ΣI | 0..* | Reference(Resource) | Part of this action |
inResponseTo | I | 0..* | Reference(Communication) | Reply to |
status | ?!ΣI | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) |
statusReason | ΣI | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example) |
category | I | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example) |
priority | ΣI | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
medium | I | 0..* | CodeableConcept | A channel of communication Binding: v3 Code System ParticipationMode (example) |
subject | ΣI | 1..1 | Reference(CH CRL Patient Profile) | Patient |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
reference | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
display | ΣI | 0..1 | string | Text alternative for the resource |
topic | I | 1..1 | CodeableConcept | Date of informing the patient Binding: CommunicationTopic (example) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
coding | ΣI | 1..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
system | ΣI | 0..1 | uri | Identity of the terminology system |
version | ΣI | 0..1 | string | Version of the system - if relevant |
code | ΣI | 0..1 | code | Symbol in syntax defined by the system |
display | ΣI | 1..1 | string | Date (YYYY-MM-DD) |
userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
text | ΣI | 0..1 | string | Plain text representation of the concept |
about | I | 0..* | Reference(Resource) | Resources that pertain to this communication |
encounter | ΣI | 0..1 | Reference(Encounter) | Encounter created as part of |
sent | I | 1..1 | dateTime | When sent |
received | I | 0..1 | dateTime | When received |
recipient | I | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient |
sender | I | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
reasonCode | ΣI | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example) |
reasonReference | ΣI | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? |
payload | I | 0..* | BackboneElement | Message payload |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
content[x] | I | 1..1 | Message part content | |
contentString | string | |||
contentAttachment | Attachment | |||
contentReference | Reference(Resource) | |||
note | I | 0..* | Annotation | Comments made about the communication |
Documentation for this format |
This structure is derived from Communication
Differential View
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | 0..* | |||
subject | 1..1 | Reference(CH CRL Patient Profile) | Patient | |
reference | 1..1 | string | ||
topic | 1..1 | CodeableConcept | Date of informing the patient | |
coding | 1..1 | Coding | ||
display | 1..1 | string | Date (YYYY-MM-DD) | |
sent | 1..1 | dateTime | ||
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 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Unique identifier |
instantiatesCanonical | ΣI | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition |
instantiatesUri | ΣI | 0..* | uri | Instantiates external protocol or definition |
basedOn | ΣI | 0..* | Reference(Resource) | Request fulfilled by this communication |
partOf | ΣI | 0..* | Reference(Resource) | Part of this action |
inResponseTo | I | 0..* | Reference(Communication) | Reply to |
status | ?!ΣI | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) |
statusReason | ΣI | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example) |
category | I | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example) |
priority | ΣI | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
medium | I | 0..* | CodeableConcept | A channel of communication Binding: v3 Code System ParticipationMode (example) |
subject | ΣI | 1..1 | Reference(CH CRL Patient Profile) | Patient |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
reference | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
display | ΣI | 0..1 | string | Text alternative for the resource |
topic | I | 1..1 | CodeableConcept | Date of informing the patient Binding: CommunicationTopic (example) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
coding | ΣI | 1..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
system | ΣI | 0..1 | uri | Identity of the terminology system |
version | ΣI | 0..1 | string | Version of the system - if relevant |
code | ΣI | 0..1 | code | Symbol in syntax defined by the system |
display | ΣI | 1..1 | string | Date (YYYY-MM-DD) |
userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
text | ΣI | 0..1 | string | Plain text representation of the concept |
about | I | 0..* | Reference(Resource) | Resources that pertain to this communication |
encounter | ΣI | 0..1 | Reference(Encounter) | Encounter created as part of |
sent | I | 1..1 | dateTime | When sent |
received | I | 0..1 | dateTime | When received |
recipient | I | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient |
sender | I | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
reasonCode | ΣI | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example) |
reasonReference | ΣI | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? |
payload | I | 0..* | BackboneElement | Message payload |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
content[x] | I | 1..1 | Message part content | |
contentString | string | |||
contentAttachment | Attachment | |||
contentReference | Reference(Resource) | |||
note | I | 0..* | Annotation | Comments made about the communication |
Documentation for this format |
Path | Conformance | ValueSet |
Communication.language | preferred | CommonLanguages Max Binding: AllLanguages |
Communication.status | required | EventStatus |
Communication.statusReason | example | CommunicationNotDoneReason |
Communication.category | example | CommunicationCategory |
Communication.priority | required | RequestPriority |
Communication.medium | example | v3.ParticipationMode |
Communication.subject.type | extensible | ResourceType |
Communication.topic | example | CommunicationTopic |
Communication.reasonCode | example | SNOMEDCTClinicalFindings |
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-3 | Communication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5 | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Communication | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | Communication.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.instantiatesUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.inResponseTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.medium | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.subject.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.subject.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.subject.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.subject.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.subject.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.subject.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.topic | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.topic.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.topic.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.topic.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.topic.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.topic.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.topic.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.topic.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.topic.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.topic.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.topic.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.topic.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.about | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.sent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.received | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.recipient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.sender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.payload | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.payload.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.payload.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Communication.payload.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Communication.payload.content[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Communication.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |