HCXPROTOCOL.IO\HCX CoverageEligibility CommunicationRequest

FHIR Implementation Guide for HCX
0.7.0 - CI Build

FHIR Implementation Guide for HCX - Local Development build (v0.7.0). See the Directory of published versions

Resource Profile: HCX CoverageEligibility CommunicationRequest

Defining URL:

https://swasth-digital-health-foundation.github.io/standards/v0.7/StructureDefinition-CommunicationRequest.html

Version:

0.7.0

Name:

CommunicationRequest

Status:

Draft as of 2019-11-01 09:29:23+1100 (Standards Status: Trial Use)

Definition:

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

Publisher:

HCX Open Community

Committee:

Patient Care

Maturity:

0

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

https://swasth-digital-health-foundation.github.io/standards/v0.7/StructureDefinition-CommunicationRequest.html

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from CommunicationRequest

Summary

Mandatory: 1 element (1 nested mandatory element)

Maturity: 0

This structure is derived from CommunicationRequest

Name	Flags	Card.	Type	Description & Constraints
CommunicationRequest		0..*	CommunicationRequest	A request for information to be sent to a receiver
identifier	Σ	0..*	Identifier	Unique identifier
basedOn	Σ	0..*	Reference(Resource)	Fulfills plan or proposal
replaces	Σ	0..*	Reference(CommunicationRequest)	Request(s) replaced by this request
groupIdentifier	Σ	0..1	Identifier	Composite request this is part of
status	?!Σ	1..1	code	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown Binding: RequestStatus (required): The status of the communication request.
statusReason		0..1	CodeableConcept	Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a request.
category		0..*	CodeableConcept	Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
priority	Σ	0..1	code	routine \| urgent \| asap \| stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
doNotPerform	?!Σ	0..1	boolean	True if request is prohibiting action
medium		0..*	CodeableConcept	A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject		0..1	Reference(Patient \| Group)	Focus of message
about		0..*	Reference(Resource)	Resources that pertain to this communication request
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
payload		0..*	BackboneElement	Message payload
content[x]		1..1		Message part content
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
occurrence[x]	Σ	0..1		When scheduled
occurrenceDateTime			dateTime
occurrencePeriod			Period
authoredOn	Σ	0..1	dateTime	When request transitioned to being actionable
requester	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization \| Patient \| RelatedPerson \| Device)	Who/what is requesting service
recipient		0..*	Reference(Device \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| Group \| CareTeam \| HealthcareService)	Message recipient
sender	Σ	0..1	Reference(Device \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| HealthcareService)	Message sender
reasonCode	Σ	0..*	CodeableConcept	Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
reasonReference	Σ	0..*	Reference(Condition \| Observation \| DiagnosticReport \| DocumentReference)	Why is communication needed?
note		0..*	Annotation	Comments made about communication request
Documentation for this format

Description & Constraints

CommunicationRequest

0..*

CommunicationRequest

A request for information to be sent to a receiver

category

0..*

CodeableConcept

Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.

priority

Σ

0..1

code

routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.

doNotPerform

?!Σ

0..1

boolean

True if request is prohibiting action

medium

0..*

CodeableConcept

A channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.

subject

0..1

Reference(Patient | Group)

Focus of message

about

0..*

Reference(Resource)

Resources that pertain to this communication request

encounter

Σ

0..1

Reference(Encounter)

Encounter created as part of

0..*

Message payload

0..*

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

content[x]

1..1

Message part content

contentString

contentAttachment

contentReference

Σ

0..1

When scheduled

occurrenceDateTime

dateTime

occurrencePeriod

Period

authoredOn

Σ

0..1

dateTime

When request transitioned to being actionable

requester

Σ

0..1

Who/what is requesting service

recipient

0..*

Message recipient

sender

Σ

0..1

Message sender

reasonCode

Σ

0..*

CodeableConcept

Why is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.

reasonReference

Σ

0..*

Reference(Condition | Observation | DiagnosticReport | DocumentReference)

Why is communication needed?

note

0..*

Annotation

Comments made about communication request

Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
CommunicationRequest		0..*	CommunicationRequest	A request for information to be sent to a receiver
Documentation for this format

This structure is derived from CommunicationRequest

Summary

Mandatory: 1 element (1 nested mandatory element)

Maturity: 0

Differential View

This structure is derived from CommunicationRequest

Name	Flags	Card.	Type	Description & Constraints
CommunicationRequest		0..*	CommunicationRequest	A request for information to be sent to a receiver
identifier	Σ	0..*	Identifier	Unique identifier
basedOn	Σ	0..*	Reference(Resource)	Fulfills plan or proposal
replaces	Σ	0..*	Reference(CommunicationRequest)	Request(s) replaced by this request
groupIdentifier	Σ	0..1	Identifier	Composite request this is part of
status	?!Σ	1..1	code	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown Binding: RequestStatus (required): The status of the communication request.
statusReason		0..1	CodeableConcept	Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a request.
category		0..*	CodeableConcept	Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
priority	Σ	0..1	code	routine \| urgent \| asap \| stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
doNotPerform	?!Σ	0..1	boolean	True if request is prohibiting action
medium		0..*	CodeableConcept	A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject		0..1	Reference(Patient \| Group)	Focus of message
about		0..*	Reference(Resource)	Resources that pertain to this communication request
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
payload		0..*	BackboneElement	Message payload
content[x]		1..1		Message part content
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
occurrence[x]	Σ	0..1		When scheduled
occurrenceDateTime			dateTime
occurrencePeriod			Period
authoredOn	Σ	0..1	dateTime	When request transitioned to being actionable
requester	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization \| Patient \| RelatedPerson \| Device)	Who/what is requesting service
recipient		0..*	Reference(Device \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| Group \| CareTeam \| HealthcareService)	Message recipient
sender	Σ	0..1	Reference(Device \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| HealthcareService)	Message sender
reasonCode	Σ	0..*	CodeableConcept	Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
reasonReference	Σ	0..*	Reference(Condition \| Observation \| DiagnosticReport \| DocumentReference)	Why is communication needed?
note		0..*	Annotation	Comments made about communication request
Documentation for this format

Snapshot View

Description & Constraints

CommunicationRequest

0..*

CommunicationRequest

A request for information to be sent to a receiver

Terminology Bindings

Path	Conformance	ValueSet
CommunicationRequest.language	preferred	CommonLanguages Max Binding: AllLanguages
CommunicationRequest.status	required	RequestStatus
CommunicationRequest.statusReason	example
CommunicationRequest.category	example	CommunicationCategory
CommunicationRequest.priority	required	RequestPriority
CommunicationRequest.medium	example	ParticipationMode
CommunicationRequest.reasonCode	example	ActReason

Constraints

Id	Grade	Path	Details	Requirements
dom-2	error	CommunicationRequest	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	CommunicationRequest	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	error	CommunicationRequest	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	error	CommunicationRequest	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Best Practice	CommunicationRequest	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	CommunicationRequest.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CommunicationRequest.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CommunicationRequest.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CommunicationRequest.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CommunicationRequest.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.basedOn	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.replaces	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.groupIdentifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.statusReason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.category	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.priority	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.doNotPerform	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.medium	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.subject	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.about	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.encounter	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.payload	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.payload.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CommunicationRequest.payload.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CommunicationRequest.payload.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CommunicationRequest.payload.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CommunicationRequest.payload.content[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.occurrence[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.authoredOn	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.requester	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.recipient	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.sender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.reasonCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.reasonReference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CommunicationRequest.note	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2021+ HCX Open Community. Package hcxprotocol.io#0.7.0 based on FHIR 4.0.1. Generated 2022-05-09
Links: Table of Contents | QA Report