communicationrequest

package
v0.0.0-...-9ef2174 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 27, 2024 License: Apache-2.0, MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CommunicationRequest 

type CommunicationRequest struct {

	// Other resources that pertain to this communication request and to which this
	// communication request should be associated.
	About []*fhir.Reference `fhirpath:"about"`

	// For draft requests, indicates the date of initial creation. For requests
	// with other statuses, indicates the date of activation.
	AuthoredOn *fhir.DateTime `fhirpath:"authoredOn"`

	// A plan or proposal that is fulfilled in whole or in part by this request.
	BasedOn []*fhir.Reference `fhirpath:"basedOn"`

	// The type of message to be sent such as alert, notification, reminder,
	// instruction, etc.
	Category []*fhir.CodeableConcept `fhirpath:"category"`

	// These resources do not have an independent existence apart from the resource
	// that contains them - they cannot be identified independently, and nor can
	// they have their own independent transaction scope.
	Contained []fhir.Resource `fhirpath:"contained"`

	// If true indicates that the CommunicationRequest is asking for the specified
	// action to *not* occur.
	DoNotPerform *fhir.Boolean `fhirpath:"doNotPerform"`

	// The Encounter during which this CommunicationRequest was created or to which
	// the creation of this record is tightly associated.
	Encounter *fhir.Reference `fhirpath:"encounter"`

	// May be used to represent additional information that is not part of the
	// basic definition of the resource. To make the use of extensions safe and
	// manageable, there is a strict set of governance applied to the definition
	// and use of extensions. Though any implementer can define an extension, there
	// is a set of requirements that SHALL be met as part of the definition of the
	// extension.
	Extension []*fhir.Extension `fhirpath:"extension"`

	// 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.
	GroupIdentifier *fhir.Identifier `fhirpath:"groupIdentifier"`

	// The logical id of the resource, as used in the URL for the resource. Once
	// assigned, this value never changes.
	ID string `fhirpath:"id"`

	// Business identifiers assigned to this communication request by the performer
	// or other systems which remain constant as the resource is updated and
	// propagates from server to server.
	Identifier []*fhir.Identifier `fhirpath:"identifier"`

	// A reference to a set of rules that were followed when the resource was
	// constructed, and which must be understood when processing the content.
	// Often, this is a reference to an implementation guide that defines the
	// special rules along with other profiles etc.
	ImplicitRules *fhir.URI `fhirpath:"implicitRules"`

	// The base language in which the resource is written.
	Language *fhir.Code `fhirpath:"language"`

	// A channel that was used for this communication (e.g. email, fax).
	Medium []*fhir.CodeableConcept `fhirpath:"medium"`

	// The metadata about the resource. This is content that is maintained by the
	// infrastructure. Changes to the content might not always be associated with
	// version changes to the resource.
	Meta *fhir.Meta `fhirpath:"meta"`

	// May be used to represent additional information that is not part of the
	// basic definition of the resource and that modifies the understanding of the
	// element that contains it and/or the understanding of the containing
	// element's descendants. Usually modifier elements provide negation or
	// qualification. To make the use of extensions safe and manageable, there is a
	// strict set of governance applied to the definition and use of extensions.
	// Though any implementer is allowed to define an extension, there is a set of
	// requirements that SHALL be met as part of the definition of the extension.
	// Applications processing a resource are required to check for modifier
	// extensions.
	// Modifier extensions SHALL NOT change the meaning of any elements on Resource
	// or DomainResource (including cannot change the meaning of modifierExtension
	// itself).
	ModifierExtension []*fhir.Extension `fhirpath:"modifierExtension"`

	// Comments made about the request by the requester, sender, recipient, subject
	// or other participants.
	Note []*fhir.Annotation `fhirpath:"note"`

	// The time when this communication is to occur.
	Occurrence fhir.Element `fhirpath:"occurrence"`

	// Text, attachment(s), or resource(s) to be communicated to the recipient.
	Payload []*CommunicationRequestPayload `fhirpath:"payload"`

	// Characterizes how quickly the proposed act must be initiated. Includes
	// concepts such as stat, urgent, routine.
	Priority *fhir.Code `fhirpath:"priority"`

	// Describes why the request is being made in coded or textual form.
	ReasonCode []*fhir.CodeableConcept `fhirpath:"reasonCode"`

	// Indicates another resource whose existence justifies this request.
	ReasonReference []*fhir.Reference `fhirpath:"reasonReference"`

	// The entity (e.g. person, organization, clinical information system, device,
	// group, or care team) which is the intended target of the communication.
	Recipient []*fhir.Reference `fhirpath:"recipient"`

	// Completed or terminated request(s) whose function is taken by this new
	// request.
	Replaces []*fhir.Reference `fhirpath:"replaces"`

	// The device, individual, or organization who initiated the request and has
	// responsibility for its activation.
	Requester *fhir.Reference `fhirpath:"requester"`

	// The entity (e.g. person, organization, clinical information system, or
	// device) which is to be the source of the communication.
	Sender *fhir.Reference `fhirpath:"sender"`

	// The status of the proposal or order.
	Status *fhir.Code `fhirpath:"status"`

	// Captures the reason for the current state of the CommunicationRequest.
	StatusReason *fhir.CodeableConcept `fhirpath:"statusReason"`

	// The patient or group that is the focus of this communication request.
	Subject *fhir.Reference `fhirpath:"subject"`

	// A human-readable narrative that contains a summary of the resource and can
	// be used to represent the content of the resource to a human. The narrative
	// need not encode all the structured data, but is required to contain
	// sufficient detail to make it "clinically safe" for a human to just read the
	// narrative. Resource definitions may define what content should be
	// represented in the narrative to ensure clinical safety.
	Text *fhir.Narrative `fhirpath:"text"`

	profileimpl.BaseDomainResource
	profileimpl.BaseResource
}

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.

Meta Details:

func (*CommunicationRequest) GetAbout 

func (cr *CommunicationRequest) GetAbout() []*fhir.Reference

GetAbout returns the value of the field About. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetAuthoredOn 

func (cr *CommunicationRequest) GetAuthoredOn() *fhir.DateTime

GetAuthoredOn returns the value of the field AuthoredOn. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetBasedOn 

func (cr *CommunicationRequest) GetBasedOn() []*fhir.Reference

GetBasedOn returns the value of the field BasedOn. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetCategory 

func (cr *CommunicationRequest) GetCategory() []*fhir.CodeableConcept

GetCategory returns the value of the field Category. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetContained 

func (cr *CommunicationRequest) GetContained() []fhir.Resource

GetContained returns the value of the field Contained. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetDoNotPerform 

func (cr *CommunicationRequest) GetDoNotPerform() *fhir.Boolean

GetDoNotPerform returns the value of the field DoNotPerform. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetEncounter 

func (cr *CommunicationRequest) GetEncounter() *fhir.Reference

GetEncounter returns the value of the field Encounter. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetExtension 

func (cr *CommunicationRequest) GetExtension() []*fhir.Extension

GetExtension returns the value of the field Extension. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetGroupIdentifier 

func (cr *CommunicationRequest) GetGroupIdentifier() *fhir.Identifier

GetGroupIdentifier returns the value of the field GroupIdentifier. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetID 

func (cr *CommunicationRequest) GetID() string

GetID returns the value of the field ID. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetIdentifier 

func (cr *CommunicationRequest) GetIdentifier() []*fhir.Identifier

GetIdentifier returns the value of the field Identifier. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetImplicitRules 

func (cr *CommunicationRequest) GetImplicitRules() *fhir.URI

GetImplicitRules returns the value of the field ImplicitRules. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetLanguage 

func (cr *CommunicationRequest) GetLanguage() *fhir.Code

GetLanguage returns the value of the field Language. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetMedium 

func (cr *CommunicationRequest) GetMedium() []*fhir.CodeableConcept

GetMedium returns the value of the field Medium. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetMeta 

func (cr *CommunicationRequest) GetMeta() *fhir.Meta

GetMeta returns the value of the field Meta. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetModifierExtension 

func (cr *CommunicationRequest) GetModifierExtension() []*fhir.Extension

GetModifierExtension returns the value of the field ModifierExtension. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetNote 

func (cr *CommunicationRequest) GetNote() []*fhir.Annotation

GetNote returns the value of the field Note. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetOccurrence 

func (cr *CommunicationRequest) GetOccurrence() fhir.Element

GetOccurrence returns the value of the field Occurrence. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetOccurrenceDateTime 

func (cr *CommunicationRequest) GetOccurrenceDateTime() *fhir.DateTime

GetOccurrenceDateTime returns the value of the field Occurrence.

func (*CommunicationRequest) GetOccurrencePeriod 

func (cr *CommunicationRequest) GetOccurrencePeriod() *fhir.Period

GetOccurrencePeriod returns the value of the field Occurrence.

func (*CommunicationRequest) GetPayload 

func (cr *CommunicationRequest) GetPayload() []*CommunicationRequestPayload

This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetPriority 

func (cr *CommunicationRequest) GetPriority() *fhir.Code

GetPriority returns the value of the field Priority. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetReasonCode 

func (cr *CommunicationRequest) GetReasonCode() []*fhir.CodeableConcept

GetReasonCode returns the value of the field ReasonCode. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetReasonReference 

func (cr *CommunicationRequest) GetReasonReference() []*fhir.Reference

GetReasonReference returns the value of the field ReasonReference. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetRecipient 

func (cr *CommunicationRequest) GetRecipient() []*fhir.Reference

GetRecipient returns the value of the field Recipient. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetReplaces 

func (cr *CommunicationRequest) GetReplaces() []*fhir.Reference

GetReplaces returns the value of the field Replaces. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetRequester 

func (cr *CommunicationRequest) GetRequester() *fhir.Reference

GetRequester returns the value of the field Requester. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetSender 

func (cr *CommunicationRequest) GetSender() *fhir.Reference

GetSender returns the value of the field Sender. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetStatus 

func (cr *CommunicationRequest) GetStatus() *fhir.Code

GetStatus returns the value of the field Status. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetStatusReason 

func (cr *CommunicationRequest) GetStatusReason() *fhir.CodeableConcept

GetStatusReason returns the value of the field StatusReason. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetSubject 

func (cr *CommunicationRequest) GetSubject() *fhir.Reference

GetSubject returns the value of the field Subject. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) GetText 

func (cr *CommunicationRequest) GetText() *fhir.Narrative

GetText returns the value of the field Text. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequest) MarshalJSON 

func (cr *CommunicationRequest) MarshalJSON() ([]byte, error)

func (*CommunicationRequest) UnmarshalJSON 

func (cr *CommunicationRequest) UnmarshalJSON(data []byte) error

type CommunicationRequestPayload 

type CommunicationRequestPayload struct {

	// The communicated content (or for multi-part communications, one portion of
	// the communication).
	Content fhir.Element `fhirpath:"content"`

	// May be used to represent additional information that is not part of the
	// basic definition of the element. To make the use of extensions safe and
	// manageable, there is a strict set of governance applied to the definition
	// and use of extensions. Though any implementer can define an extension, there
	// is a set of requirements that SHALL be met as part of the definition of the
	// extension.
	Extension []*fhir.Extension `fhirpath:"extension"`

	// Unique id for the element within a resource (for internal references). This
	// may be any string value that does not contain spaces.
	ID string `fhirpath:"id"`

	// May be used to represent additional information that is not part of the
	// basic definition of the element and that modifies the understanding of the
	// element in which it is contained and/or the understanding of the containing
	// element's descendants. Usually modifier elements provide negation or
	// qualification. To make the use of extensions safe and manageable, there is a
	// strict set of governance applied to the definition and use of extensions.
	// Though any implementer can define an extension, there is a set of
	// requirements that SHALL be met as part of the definition of the extension.
	// Applications processing a resource are required to check for modifier
	// extensions.
	// Modifier extensions SHALL NOT change the meaning of any elements on Resource
	// or DomainResource (including cannot change the meaning of modifierExtension
	// itself).
	ModifierExtension []*fhir.Extension `fhirpath:"modifierExtension"`

	profileimpl.BaseBackboneElement
	profileimpl.BaseElement
}

Message payload// Text, attachment(s), or resource(s) to be communicated to the recipient.

Meta Details:

  • Package IG: hl7.fhir.r4.core@4.0.1
  • StructureDefinition:
  • Source File: StructureDefinition-CommunicationRequest.json

func (*CommunicationRequestPayload) GetContent 

func (crp *CommunicationRequestPayload) GetContent() fhir.Element

GetContent returns the value of the field Content. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequestPayload) GetContentAttachment 

func (crp *CommunicationRequestPayload) GetContentAttachment() *fhir.Attachment

GetContentAttachment returns the value of the field Content.

func (*CommunicationRequestPayload) GetContentReference 

func (crp *CommunicationRequestPayload) GetContentReference() *fhir.Reference

GetContentReference returns the value of the field Content.

func (*CommunicationRequestPayload) GetContentString 

func (crp *CommunicationRequestPayload) GetContentString() *fhir.String

GetContentString returns the value of the field Content.

func (*CommunicationRequestPayload) GetExtension 

func (crp *CommunicationRequestPayload) GetExtension() []*fhir.Extension

This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequestPayload) GetID 

func (crp *CommunicationRequestPayload) GetID() string

GetID returns the value of the field ID. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequestPayload) GetModifierExtension 

func (crp *CommunicationRequestPayload) GetModifierExtension() []*fhir.Extension

GetModifierExtension returns the value of the field ModifierExtension. This function is safe to call on nil pointers, and will return the zero value instead.

func (*CommunicationRequestPayload) MarshalJSON 

func (crp *CommunicationRequestPayload) MarshalJSON() ([]byte, error)

func (*CommunicationRequestPayload) UnmarshalJSON 

func (crp *CommunicationRequestPayload) UnmarshalJSON(data []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.