| Common UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
"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 |
Pointer to those data elements that are common to the CommunicationEvent and CommunicationRequest classes. |
«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 |
«CS» Code | reasonCode |
"Describes why the request is being made in coded or textual form." - HL7 FHIR, CommunicationRequest.reasonCodeNote 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 |
"Completed or terminated request(s) whose function is taken by this new request." - HL7 FHIR, CommunicationRequest.replaces |
«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.statusNote 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 |
"Captures the reason for the current state of the CommunicationRequest." - HL7 FHIR, CommunicationRequest.statusReasonNote 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 | ||
advanceBeneficiaryNoticeCode, advanceBeneficiaryNoticeDate, advanceBeneficiaryNoticeOverrideReason, alternatePlacerOrderId, basedOn, billingInformation, callbackPhone, confidentialityCode, dangerCode, dateTimeBegin, dateTimeCompleted, dateTimeEnd, dateTimeNeeded, dateTimeOrdered, diagnosisList, doNotPerform, duplicateProcedureReason, enteringLocation, expectedPerformer, expectedPerformerType, isEscortRequired, isInpatientOrder, occurrenceTiming, orderAction, orderingFacility, orderingOrganization, orderingProvider, patientInstructions, patientLocation, placerOrderId, placerSupplementalInfo, plannedPatientTransportComment, precautionProtocolInvoked, priority, promise, reasonForStudy, releaseStatus, relevantClinicalInformation, resultCopiesTo, resultHandling, setOfOrders, standingOrder, status, statusModifier, suggestedPrecaution, transportationArrangementResponsibility, transportationMode, wasTransportArranged |
Attributes inherited from FHIM::Common::InformationEntry | ||
identifier |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | CommunicationRequest |
Name Expression | |
Namespace | Common |
Owned Template Signature | |
Owner | Common |
Owning Template Parameter | |
Package | Common |
Qualified Name | FHIM::Common::CommunicationRequest |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public CommunicationTopic communicationTopic
Pointer to those data elements that are common to the CommunicationEvent and CommunicationRequest classes.
Aggregation | None |
Alias | |
Association | communicationRequest_communicationTopic |
Association End | |
Class | CommunicationRequest |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | communicationTopic |
Name Expression | |
Namespace | CommunicationRequest |
Opposite | |
Owner | CommunicationRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationRequest::communicationTopic |
Stereotype | |
Template Parameter | |
Type | CommunicationTopic |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationRequest |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | groupIdentifier |
Name Expression | |
Namespace | CommunicationRequest |
Opposite | |
Owner | CommunicationRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationRequest::groupIdentifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code reasonCode
"Describes why the request is being made in coded or textual form." - HL7 FHIR, CommunicationRequest.reasonCodeNote 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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationRequest |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | reasonCode |
Name Expression | |
Namespace | CommunicationRequest |
Opposite | |
Owner | CommunicationRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationRequest::reasonCode |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public CommunicationRequest replaces
"Completed or terminated request(s) whose function is taken by this new request." - HL7 FHIR, CommunicationRequest.replaces
Aggregation | None |
Alias | |
Association | communicationRequest_inResponseTo |
Association End | |
Class | CommunicationRequest |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | replaces |
Name Expression | |
Namespace | CommunicationRequest |
Opposite | |
Owner | CommunicationRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationRequest::replaces |
Stereotype | |
Template Parameter | |
Type | CommunicationRequest |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.statusNote 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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationRequest |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | status |
Name Expression | |
Namespace | CommunicationRequest |
Opposite | |
Owner | CommunicationRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationRequest::status |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code statusReason
"Captures the reason for the current state of the CommunicationRequest." - HL7 FHIR, CommunicationRequest.statusReasonNote 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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationRequest |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | statusReason |
Name Expression | |
Namespace | CommunicationRequest |
Opposite | |
Owner | CommunicationRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationRequest::statusReason |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Common UML Documentation |
Summary:AttributesProperties | Detail:Attributes |