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: CommunicationRequestSTU3

The official URL for this profile is: 

http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-communicationreq-stu3

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: Common Languages (extensible)
Max Binding: All Languages
... text I0..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(CommunicationRequestSTU3)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
... category 0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority Σ0..1codeMessage urgency
Binding: RequestPriority (required)
... medium 0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example)
... subject S1..1Reference(PatientSTU3)Focus of message
... recipient S0..*Reference(PractitionerSTU3)Message recipient
... topic 0..*Reference(Resource)Focal resources
... context Σ0..1Reference(EncounterSTU3)Encounter or episode leading to message
... payload I0..*BackboneElementMessage payload
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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
... sender S0..1Reference(PractitionerSTU3)Message sender
... requester ΣI1..1BackboneElementWho/what is requesting service
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent SΣ1..1Reference(PractitionerSTU3)Individual making the request
.... onBehalfOf ΣI0..1Reference(Organization)Organization agent is acting for
... reasonCode SΣ0..*CodeableConceptWhy is communication needed?
Binding: ActReason (example)
... reasonReference Σ0..*Reference(US Core Condition Profile | US Core Result Observation)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: Common Languages (extensible)
Max Binding: All Languages
... text I0..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(CommunicationRequestSTU3)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
... category 0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority Σ0..1codeMessage urgency
Binding: RequestPriority (required)
... medium 0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example)
... subject S1..1Reference(PatientSTU3)Focus of message
... recipient S0..*Reference(PractitionerSTU3)Message recipient
... topic 0..*Reference(Resource)Focal resources
... context Σ0..1Reference(EncounterSTU3)Encounter or episode leading to message
... payload I0..*BackboneElementMessage payload
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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
... sender S0..1Reference(PractitionerSTU3)Message sender
... requester ΣI1..1BackboneElementWho/what is requesting service
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent SΣ1..1Reference(PractitionerSTU3)Individual making the request
.... onBehalfOf ΣI0..1Reference(Organization)Organization agent is acting for
... reasonCode SΣ0..*CodeableConceptWhy is communication needed?
Binding: ActReason (example)
... reasonReference Σ0..*Reference(US Core Condition Profile | US Core Result Observation)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 Code System ActReason

Constraints

IdPathDetailsRequirements
dom-2CommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1CommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.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
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1CommunicationRequest.payloadAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1CommunicationRequest.requesterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
cmr-1CommunicationRequest.requesteronBehalfOf can only be specified if agent is practitioner or device
: (agent.resolve() is Practitioner) or (agent.resolve() is Device) or onBehalfOf.exists().not()