0.3.0 - Second STU ballot

This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.3.0: STU 1 Ballot 2) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: CommunicationRequestR4

The official URL for this profile is: 

http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest-r4

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest I0..*A request for information to be sent to a receiver
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier
... basedOn SΣ1..1Reference(Resource)Fulfills plan or proposal
... replaces Σ0..*Reference(CommunicationRequestR4)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!SΣ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required)
Fixed Value: draft
... statusReason 0..1CodeableConceptReason for current status
Binding: (unbound) (example)
... category 0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority Σ0..1codeMessage urgency
Binding: RequestPriority (required)
... medium 0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject S1..1Reference(PatientR4)Focus of message
... about 0..*Reference(Resource)Resources that pertain to this communication request
... encounter Σ0..1Reference(EncounterR4)Encounter created as part of
... payload I0..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1string, Attachment, Reference(Resource)Message part content
... occurrence[x] SΣ0..1dateTime, PeriodWhen scheduled
... authoredOn SΣ1..1dateTimeWhen request transitioned to being actionable
... requester SΣ1..1Reference(PractitionerR4 | US Core PractitionerRole Profile)Who/what is requesting service
... recipient S0..*Reference(PractitionerR4 | US Core PractitionerRole Profile)Message recipient
... sender SΣ0..1Reference(PractitionerR4 | US Core PractitionerRole Profile)Message sender
... reasonCode SΣ0..*CodeableConceptWhy is communication needed?
Binding: v3 Code System ActReason (example)
... reasonReference SΣ0..*Reference(US Core Condition Profile | US Core Result Observation Profile)Why is communication needed?
... note 0..*AnnotationComments made about communication request

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest I0..*A request for information to be sent to a receiver
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier
... basedOn SΣ1..1Reference(Resource)Fulfills plan or proposal
... replaces Σ0..*Reference(CommunicationRequestR4)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!SΣ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required)
Fixed Value: draft
... statusReason 0..1CodeableConceptReason for current status
Binding: (unbound) (example)
... category 0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority Σ0..1codeMessage urgency
Binding: RequestPriority (required)
... medium 0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject S1..1Reference(PatientR4)Focus of message
... about 0..*Reference(Resource)Resources that pertain to this communication request
... encounter Σ0..1Reference(EncounterR4)Encounter created as part of
... payload I0..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1string, Attachment, Reference(Resource)Message part content
... occurrence[x] SΣ0..1dateTime, PeriodWhen scheduled
... authoredOn SΣ1..1dateTimeWhen request transitioned to being actionable
... requester SΣ1..1Reference(PractitionerR4 | US Core PractitionerRole Profile)Who/what is requesting service
... recipient S0..*Reference(PractitionerR4 | US Core PractitionerRole Profile)Message recipient
... sender SΣ0..1Reference(PractitionerR4 | US Core PractitionerRole Profile)Message sender
... reasonCode SΣ0..*CodeableConceptWhy is communication needed?
Binding: v3 Code System ActReason (example)
... reasonReference SΣ0..*Reference(US Core Condition Profile | US Core Result Observation Profile)Why is communication needed?
... note 0..*AnnotationComments made about communication request

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
CommunicationRequest.statusrequiredFixed Value: draft
CommunicationRequest.reasonCodeexamplev3.ActReason

Constraints

IdPathDetailsRequirements
dom-2CommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4CommunicationRequestIf 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-3CommunicationRequestIf 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-6CommunicationRequestA resource should have narrative for robust management
: text.div.exists()
dom-5CommunicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1CommunicationRequest.payloadAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())