Common
Class CommunicationRequest

"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." - HL7 FHIR, CommunicationRequest

Attributes
CommunicationTopic communicationTopic communicationTopic

Pointer to those data elements that are common to the CommunicationEvent and CommunicationRequest classes.

«II» Id groupIdentifier groupIdentifier

"A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form." - HL7 FHIR, CommunicationRequest.groupIdentifier

«CS» Code reasonCode reasonCode

"Describes why the request is being made in coded or textual form." - HL7 FHIR, CommunicationRequest.reasonCode
Note that while both Communication and CommunicationRequest have a reasonCode (and therefore, one might reasonably assume that this would be in the CommunicationTopic class), the two classes bind their reasonCode to different value sets (Communication.reasonCode binds to SNOMED CT Clinical Findings, while CommunicationRequest.reasonCode binds to the V3 ActReason value set). Therefore, these properties are modeled separately in each class.

CommunicationRequest replaces replaces

"Completed or terminated request(s) whose function is taken by this new request." - HL7 FHIR, CommunicationRequest.replaces

«CS» Code status status

"The status of the transmission." Possible values are: Preparation; In Progress; Not Done; On Hold; Stopped; Completed; Entered in Error; Unknown. - HL7 FHIR, Communication.status
Note that while both Communication and CommunicationRequest have a status and are inheriting a recordStatus property from ClinicalStatement, the two classes bind their status properties to different value sets. Therefore, these properties are modeled separately in each class, whereby they re-define the recordStatus property.

«CS» Code statusReason statusReason

"Captures the reason for the current state of the CommunicationRequest." - HL7 FHIR, CommunicationRequest.statusReason
Note that while both Communication and CommunicationRequest have a statusReason, the two classes bind to different value sets. Therefore, these properties are modeled separately in each class.

Attributes inherited from FHIM::Orders::Order FHIM::Orders::Order
advanceBeneficiaryNoticeCode advanceBeneficiaryNoticeCode, advanceBeneficiaryNoticeDate advanceBeneficiaryNoticeDate, advanceBeneficiaryNoticeOverrideReason advanceBeneficiaryNoticeOverrideReason, alternatePlacerOrderId alternatePlacerOrderId, basedOn basedOn, billingInformation billingInformation, callbackPhone callbackPhone, confidentialityCode confidentialityCode, dangerCode dangerCode, dateTimeBegin dateTimeBegin, dateTimeCompleted dateTimeCompleted, dateTimeEnd dateTimeEnd, dateTimeNeeded dateTimeNeeded, dateTimeOrdered dateTimeOrdered, diagnosisList diagnosisList, doNotPerform doNotPerform, duplicateProcedureReason duplicateProcedureReason, enteringLocation enteringLocation, expectedPerformer expectedPerformer, expectedPerformerType expectedPerformerType, isEscortRequired isEscortRequired, isInpatientOrder isInpatientOrder, occurrenceTiming occurrenceTiming, orderAction orderAction, orderingFacility orderingFacility, orderingOrganization orderingOrganization, orderingProvider orderingProvider, patientInstructions patientInstructions, patientLocation patientLocation, placerOrderId placerOrderId, placerSupplementalInfo placerSupplementalInfo, plannedPatientTransportComment plannedPatientTransportComment, precautionProtocolInvoked precautionProtocolInvoked, priority priority, promise promise, reasonForStudy reasonForStudy, releaseStatus releaseStatus, relevantClinicalInformation relevantClinicalInformation, resultCopiesTo resultCopiesTo, resultHandling resultHandling, setOfOrders setOfOrders, standingOrder standingOrder, status status, statusModifier statusModifier, suggestedPrecaution suggestedPrecaution, transportationArrangementResponsibility transportationArrangementResponsibility, transportationMode transportationMode, wasTransportArranged wasTransportArranged

Attributes inherited from FHIM::Common::ActionStatement FHIM::Common::ActionStatement
category category, currentStatus currentStatus, description description, indication indication, inputFinding inputFinding, instantiatesCanonical instantiatesCanonical, instantiatesUri instantiatesUri, insurance insurance, intent intent, justification justification, location location, method method, outputFinding outputFinding, precondition precondition, reasonCode reasonCode, reasonNarrative reasonNarrative, reasonReference reasonReference, relevantHistory relevantHistory, scope scope, supportingInformation supportingInformation, usingDevice usingDevice, wasReported wasReported

Attributes inherited from FHIM::Common::ClinicalStatement FHIM::Common::ClinicalStatement
clinicalDataSource clinicalDataSource, contentVersion contentVersion, contextCode contextCode, encounter encounter, note note, recordStatus recordStatus, relatedClinicalInformation relatedClinicalInformation, sourceRecordType sourceRecordType, sourceSystem sourceSystem, subjectGroup subjectGroup, subjectOfInformation subjectOfInformation, subjectOfRecord subjectOfRecord, temporalContext temporalContext, topicCode topicCode, cosigned cosigned, recorded recorded, signed signed, verified verified

Attributes inherited from FHIM::Common::InformationEntry FHIM::Common::InformationEntry
identifier identifier

Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameCommunicationRequest
Name Expression
NamespaceCommon
Owned Template Signature
OwnerCommon
Owning Template Parameter
PackageCommon
Qualified NameFHIM::Common::CommunicationRequest
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 communicationTopic
Public CommunicationTopic communicationTopic

Pointer to those data elements that are common to the CommunicationEvent and CommunicationRequest classes.

Constraints:
Properties:

AggregationNone
Alias
AssociationcommunicationRequest_communicationTopic
Association End
ClassCommunicationRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamecommunicationTopic
Name Expression
NamespaceCommunicationRequest
Opposite
OwnerCommunicationRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationRequest::communicationTopic
Stereotype
Template Parameter
TypeCommunicationTopic
Upper1
Upper Value(1)
VisibilityPublic


 groupIdentifier
Public «II» Id groupIdentifier

"A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form." - HL7 FHIR, CommunicationRequest.groupIdentifier

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamegroupIdentifier
Name Expression
NamespaceCommunicationRequest
Opposite
OwnerCommunicationRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationRequest::groupIdentifier
Stereotype
Template Parameter
Type«II» Id
Upper1
Upper Value(1)
VisibilityPublic


 reasonCode
Public «CS» Code reasonCode

"Describes why the request is being made in coded or textual form." - HL7 FHIR, CommunicationRequest.reasonCode
Note that while both Communication and CommunicationRequest have a reasonCode (and therefore, one might reasonably assume that this would be in the CommunicationTopic class), the two classes bind their reasonCode to different value sets (Communication.reasonCode binds to SNOMED CT Clinical Findings, while CommunicationRequest.reasonCode binds to the V3 ActReason value set). Therefore, these properties are modeled separately in each class.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamereasonCode
Name Expression
NamespaceCommunicationRequest
Opposite
OwnerCommunicationRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationRequest::reasonCode
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 replaces
Public CommunicationRequest replaces

"Completed or terminated request(s) whose function is taken by this new request." - HL7 FHIR, CommunicationRequest.replaces

Constraints:
Properties:

AggregationNone
Alias
AssociationcommunicationRequest_inResponseTo
Association End
ClassCommunicationRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namereplaces
Name Expression
NamespaceCommunicationRequest
Opposite
OwnerCommunicationRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationRequest::replaces
Stereotype
Template Parameter
TypeCommunicationRequest
Upper*
Upper Value(*)
VisibilityPublic


 status
Public «CS» Code status

"The status of the transmission." Possible values are: Preparation; In Progress; Not Done; On Hold; Stopped; Completed; Entered in Error; Unknown. - HL7 FHIR, Communication.status
Note that while both Communication and CommunicationRequest have a status and are inheriting a recordStatus property from ClinicalStatement, the two classes bind their status properties to different value sets. Therefore, these properties are modeled separately in each class, whereby they re-define the recordStatus property.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namestatus
Name Expression
NamespaceCommunicationRequest
Opposite
OwnerCommunicationRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationRequest::status
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 statusReason
Public «CS» Code statusReason

"Captures the reason for the current state of the CommunicationRequest." - HL7 FHIR, CommunicationRequest.statusReason
Note that while both Communication and CommunicationRequest have a statusReason, the two classes bind to different value sets. Therefore, these properties are modeled separately in each class.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamestatusReason
Name Expression
NamespaceCommunicationRequest
Opposite
OwnerCommunicationRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationRequest::statusReason
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic